202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务) 204 NO CONTENT - [D

时间:2022-01-08 06:08:23

网络应用措施,分为前端和后端两个部分。当前的成长趋势,就是前端设备屡见不鲜(手机、平板、桌面电脑、其他专用设备......)。

因此,必需有一种统一的机制,便利差此外前端设备与后端进行通信。这导致API构架的风行,甚至呈现"API First"的设计思想。RESTful API是目前对照成熟的一套互联网应用措施的API设计理论

一、协议

API与用户的通信协议,总是使用HTTPs协议。

二、域名

1.应该尽量将API部署在专用域名之下,(这中情况会存在跨域问题)

https://api.example.com

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

https://example.org/api/

三、版本(Versioning)

应该将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应该供给参数,过滤返回功效。

下面是一些常见的参数。

https://api.example.com/v1/zoos?limit=10:指定返回记录的数量

https://api.example.com/v1/zoos?offset=10:指定返回记录的开始位置

https://api.example.com/v1/zoos?page=2&per_page=100:指定第几页,以及每页的记录数

https://api.example.com/v1/zoos?sortby=name&order=asc:指定返回功效凭据哪个属性排序,以及排序挨次

https://api.example.com/v1/zoos?animal_type_id=1:指定筛选条件

参数的设计允许存在冗余,即允许API路径和URL参数偶尔有反复。好比,GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是不异的。

七、状态码(Status Codes)

处事器向用户返回的状态码和提示信息,常见的有以下一些(方括号中是该状态码对应的HTTP动词)。

200 OK - [GET]:处事器告成返回用户请求的数据,该操纵是幂等的(Idempotent)。

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 - [*]:用户发出的请求针对的是不存在的记录,处事器没有进行操纵,该操纵是幂等的。

406 Not Acceptable - [GET]:用户请求的格局不成得(好比用户请求JSON格局,但是只有XML格局)。

410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。

422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个东西时,产生一个验证错误。

500 INTERNAL SERVER ERROR - [*]:处事器产生错误,用户将无法判断发出的请求是否告成。

状态码的完全列表参见这里。

八、错误措置惩罚惩罚(Error handling)

如果状态码是4xx,就应该向用户返回堕落信息。一般来说,返回的信息中将error作为键名,堕落信息作为键值即可。

{ error: "Invalid API key" }

九、返回功效

针对差别操纵,处事器向用户返回的功效应该切合以下规范。

GET /collection:返回资源东西的列表(数组)

GET /collection/resource:返回单个资源东西

POST /collection:返回新生成的资源东西

PUT /collection/resource:返回完整的资源东西

PATCH /collection/resource:返回完整的资源东西

DELETE /collection/resource:返回一个空文档

十、Hypermedia API

RESTful API最好做到Hypermedia,即返回功效*给链接,连向其他API要领,使得用户不查文档,也知道下一步应该做什么。

好比,当用户向api.example.com的根目录发出请求,会得到这样一个文档。