API 最佳实践

2019/5/9 posted in  SpringBoot

初衷

旨在对api规划之初做出约定,使研发成员建立默契,提升研发品质和效率

协议

使用 https 协议最佳

域名、版本

https://api.example.com/v1/... 推荐

https://example.com/api/v1/...

URL 设计

每个API代表一种资源,所以路径中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数
https://api.example.com/v1/zoos
https://api.example.com/v1/users
https://api.example.com/v1/animals

HTTP 方法对应CRUD操作

GET :获取
POST:新建
PUT :更新(客户端提供改变后的完整资源)
PATCH :更新(客户端提供改变部分的属性)
DELETE:删除资源
HEAD :获取资源的元数据。
OPTIONS :获取资源的哪些属性是客户端可以改变的

访问示例

参数的设计允许存在冗余,即允许API路径和URL参数偶尔有重复。比如,GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。
GET /zoos:列出所有动物园
POST /zoos:新建一个动物园
GET /zoos/ID :获取某个指定动物园的信息
PUT /zoos/ID :更新某个指定动物园的信息(提供该动物园的全部信息)
PATCH /zoos/ID:更新某个指定动物园的信息(提供该动物园的部分信息)
DELETE /zoos/ID:删除某个动物园
GET /zoos/ID/animals :列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物

过滤、分页

?limit=10 :指定返回10条记录
?offset=10:指定从第10条记录开始返回
?page=2&per_page=100:指定第几页,以及每页的记录数
?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序
?animal_type_id=1:指定筛选条件

响应状态(或者全局返回200,在响应内容中标记请求的结果状态)

200 OK - [GET]:服务器成功返回用户请求的数据,操作幂等
201 CREATED - [POST/PUT/PATCH]:新建或修改数据成功
202 Accepted - []:表示一个请求已经进入后台排队(异步任务)
204 NO CONTENT - [DELETE]:用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,操作幂等
401 Unauthorized - [
]:表示用户没有权限(令牌、用户名、密码错误)。
403 Forbidden - [] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
404 NOT FOUND - [
]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,操作幂等
405 Method Not Allowed - 请求方式不支持
406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

响应示例

GET /collection:返回资源对象的列表(数组)
GET /collection/resource:返回单个资源对象
POST /collection:返回新生成的资源对象
PUT /collection/resource:返回完整的资源对象
PATCH /collection/resource:返回完整的资源对象
DELETE /collection/resource:返回一个空文档