RESTful接口设计规范

Posted So istes immer

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了RESTful接口设计规范相关的知识,希望对你有一定的参考价值。

目录

1.协议

API与用户的通信协议,尽量使用HTTPs协议

2.域名

应尽量将API部署在专用域名之下

https://api.example.com

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

https://example.org/api/

3.版本

应将API的版本号放入URL。

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

另一种做法是将版本号放在HTTP头信息中,但是不如放在URL中直观和方便,Github采用这种方法。

4.路径

路径又称"终点"(endpoint),表示API的具体网址

在RESTful架构中,每个网址代表一种资源,所以网址中不能有动词,只能有名词,而且所用名词往往与数据库的表格名对应。一般来说,数据库的表都是同种记录的"集合",所以API中的名词也应该使用复数。

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

5.HTTP动词

对于资源的具体操作类型,由HTTP动词表示

常用:

GET(读取)、POST(创建)、PUT(完整更新)、PATCH(部分更新)、DELETE(删除)

不常用:

HEAD(获取资源的元数据)、OPTIONS(获取信息,关于资源的哪些属性是客户端可以改变的)

6.过滤信息

如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。 

常见参数

?limit=10: 指定返回记录的数量

 ?offset=10: 指定返回记录的开始位置

?page=2&per_page=100: 指定第几页,以及每页的记录数

?sortby=name&order=asc: 指定返回结果按照哪个属性排序,以及排序顺序

?animal_type_id=1: 指定筛选条件

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

7.状态码

客户端的每一次请求,服务器都必须给出回应。回应包括HTTP状态码和数据两部分

HTTP状态码就是一个三位数,分成五个类别

1xx: 相关信息

2xx: 操作成功

3xx: 重定向

4xx: 客户端错误

5xx: 服务器端错误

常见

200 OK:服务器成功返回用户请求(get请求)的数据

201 CREATED: 用户创建或修改数据成功(post/put/patch)

202 Accepted: 表示一个请求已经进入后台排队(异步任务)

204 NO CONTENT: 用户删除数据成功(delete)

400 INVALID REQUEST: 用户发出的请求有错误,服务器没有进行新建或修改数据的操作

401 Unauthorized: 表示用户没有权限(令牌、用户名、密码错误)

403 Forbidden: 表示用户得到授权(与401错误相对),但是访问是被禁止的

404 NOT FOUND: 用户发出的请求针对的是不存在的记录,服务器没有进行操作

406 Not Acceptable: 用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)

410 Gone: 用户请求(get请求)的资源被永久删除,且不会再得到

422 Unprocesable entity 当创建一个对象时,发生一个验证错误(post/put/patch)

500 INTERNAL SERVER ERROR: 服务器发生错误,用户将无法判断发出的请求是否成功

8. 返回结果

API返回的数据格式,不应该是纯文本,而应该是一个JSON对象,因为这样才能返回标准的结构化数据。所以,服务器回应的HTTP头的Content-Type属性要设计为application/json

针对不同操作,服务器向用户返回的结果应该符合以下规范

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

9. 错误处理

状态码反映发生的错误,具体的错误信息放在数据体里面返回。

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "error": "Invalid payload"
  "detail": {
     "surname": "This field is required."
   }
}

10.身份认证

基于JWI的接口权限认证:

字段名:Authorization

字段值:Bearer token数据

11.跨域处理

可以在服务端设置CORS运行客户端跨域资源请求

以上是关于RESTful接口设计规范的主要内容,如果未能解决你的问题,请参考以下文章

Express应用案例 - RESTful接口设计规范

RESTful 接口设计规范

转:RESTful API接口设计标准及规范

restFul接口设计规范

restFul接口设计规范

RESTful API接口设计规范