logo  

Java编程实用经验

Java编程实用经验
作者: 陈安廉

摘要:软件开发进阶系列


接口命名规范


2022-03-16 09:24:45

  1. 所有json结果接口带有api,如/api/user/update

  2. 所有更新为主的接口带有update,如/api/user/update

  3. 所有新增为主的接口带有add,如/api/user/add

  4. 所有删除为主的接口带有delete,如/api/user/delete

  5. 所有分页查询接口带有page,如/api/user/page

  6. 所有不分页列表查询接口带有list,如/api/user/list

  7. 所有查询单个实体信息的接口带有detail,如/api/user/detail

  8. 所有页面带有.html。首页除外,如/。参考如下:

    分页列表页:/user/page.html

    详情页:/user/detail.html

    新增页:/user/add.html

    更新页:/user/update.html

    删除页:/user/delete.html