API规范
# RESTful风格
在RESTful架构中,每个URL代表一种资源,所以不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合",所以API中的名词也应该使用复数。
最佳案例
请求名称 | 请求方法 | 请求路径 |
---|---|---|
获取所有用户信息 | GET | /api/v1/users |
获取标识为1用户信息 | GET | /api/v1/users/1 |
删除标识为1用户信息 | DELETE | /api/v1/users/1 |
新增用户 | POST | /api/v1/users |
修改标识为1用户信息 | PUT | /api/v1/users/1 |
修改标识为1用户部分信息 | Patch | /api/v1/users/1 |
获取当前登录用户信息 | GET | /api/v1/users/me |
# 错误码规范
上次更新: 2022/05/15, 10:01:11