1.uri命名规范简介
URI命名规范是HTTP协议中用于标识资源的统一资源定位符，它由协议、域名、端口、路径、参数等构成，用于描述一个资源。 在设计URI的时候，需要遵守一定的规范，以方便其他开发者理解、使用、维护。 由于RESTFul规范过于宽松，所以需要根据具体的业务场景来确定是否需要遵守RESTFul规范。本项目中，只对请求方式和请求uri前缀符合RESTFul规范进行约束。
2.前缀uri命名规范
命名方式： 系统名称/模块名称/接口用途
3.接口用途部分uri命名规范
- 统一使用小驼峰命名。形如：/user/getById
- 增删改查分别使用 POST、DELETE、PUT、GET 请求方法
- 增删改查使用统一动宾结构前缀，如：add、remove、edit、get、list、getById
部分约束规范如下：
| 接口用途 | 请求方式 | 命名规范 |
|---|---|---|
| 分页查询 | GET | page |
| 查询列表 | GET | list |
| 通过id查询 | GET | getById/ |
| 修改状态 | PUT | editState |
| 添加 | POST | add |
| 修改 | PUT | edit |
| 删除 | DELETE | remove |
| 根据id删除接口 | DELETE | removeById/ |
| 批量删除接口 | DELETE | removeBatchByIds |
| 导出excel | GET | exportXls |
| 导入excel | POST | importXls |
| 获取树形结构 | GET | GET |
| 分页查询软删除数据 | GET | /logic/page |
| 恢复软删除数据 | PUT | logic/restoreById/ |
| 批量恢复软删除数据 | PUT | logic/restoreByIds |
| 根据id删除软删除数据 | DELETE | logic/del/ |
| 根据ids批量删除软删除数据 | DELETE | /logic/deleteBatch |