API应该提供参数

时间:2021-08-30 07:19:36

网络应用措施,分为前端和后端两个部分。当前的成长趋势,就是前端设备屡见不鲜(手机、平板、桌面电脑、其他专用设备...)。
因此,必需有一种统一的机制,便利差此外前端设备与后端进行通信。这导致API架构的风行,甚至呈现"API First"的设计思想。RESTful API是目前对照成熟的一套互联网应用措施的API设计理论。今天,主要介绍RESTful API的设计细节,探讨如何设计一套合理、好用的API。

API应该提供参数

一、协议
API与用户的通信协议,总是使用HTTP协议。
二、域名
应该尽量将API部署在专用域名之下

https://api.example.com

如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下

https://example.org/api/

三、版本
应该将API的版本号放入URL

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

另一种做法是,将版本号放在HTTP头信息中,但不如放入URL便利和直不雅观。给与这种做法。
四、路径(Endpoint)
路径又称"终点(endpoint)",暗示API的具体网址。
在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"调集(collection)",所以API中的名词也应该使用复数。
距离来说,有一个API供给动物园(zoo)的信息,还包孕各类动物和雇员的信息,则它的路径应该设计成下面这样

- https://api.example.com/v1/zoos - https://api.example.com/v1/animals - https://api.example.com/v1/employees

五、HTTP动词
对付资源的具体操纵类型,由HTTP动词暗示。
常用的HTTP动词有下面五个(括号里是对应的SQL命令)

- GET(SELECT):从处事器取出资源(一项或多项) - POST(CREATE):在处事器新建一个资源 - PUT(UPDATE):在处事器更新资源(客户端供给转变后的完整资源) - PATCH(UPDATE):在处事器更新资源(客户端供给转变的属性) - DELETE(DELETE):从处事器删除资源

还有两个不常用的HTTP动词

- HEAD:获取资源的元数据 - OPTIONS:获取信息,关于资源的哪些属性是客户端可以转变的

下面是一些例子

- 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:删除某个指定动物园的指定动物

六、过滤信息(Filtering)
如果记录数据量很多,处事器不成能都将它们返回给用户。API应该供给参数,过滤返回功效。
下面是一些常见的参数:

- ?limit=10:指定返回记录的数量 - ?offset=10:指定返回记录的开始位置 - ?page=2&per_page=100:指定第几页,以及每页的记录数 - ?sortby=name&order=asc:指定返回功效凭据哪个属性排序,以及排序挨次 - ?animal_type_id:指定筛选条件

参数的设定允许存在冗余,即允许API路径和URL参数偶尔有反复。好比,GET /zoo/ID/animals 与GET /animals?zoo_id=ID的含义是一样的。
七、状态码
处事器向用户返回的状态码和提示信息,常见的有以下一些(方括号是该状态码对应的HTTP动词)

- 200 OK [GET]:处事器告成返回用户请求的数据,,该操纵是幂等的(Idempotent) - 201 CREATE [POST/PUT/PATCH]:用户新建或者改削数据告成