RESTful API 设计规范整理

2019-02-15 本文已影响0人 IT513

[TOC]

HTTP 请求规范

GET（SELECT）：查询; 从服务器取出资源（一项或多项）。
POST（CREATE）：新增; 在服务器新建一个资源。
PUT（UPDATE）：覆盖,全部更新 ; 在服务器更新资源（客户端提供改变后的完整资源）。
PATCH（UPDATE）：更新; 在服务器更新资源（客户端提供改变的属性）。
DELETE（DELETE）：删除; 从服务器删除资源。

HTTP 状态码

状态码范围

1xx 信息，请求收到，继续处理。范围保留用于底层HTTP的东西，你很可能永远也用不到。
2xx 成功，行为被成功地接受、理解和采纳
3xx 重定向，为了完成请求，必须进一步执行的动作
4xx 客户端错误，请求包含语法错误或者请求无法实现。范围保留用于响应客户端做出的错误，例如。他们提供不良数据或要求不存在的东西。这些请求应该是幂等的，而不是更改服务器的状态。
5xx 范围的状态码是保留给服务器端错误用的。这些错误常常是从底层的函数抛出来的，甚至开发人员也通常没法处理，发送这类状态码的目的以确保客户端获得某种响应。当收到5xx响应时，客户端不可能知道服务器的状态，所以这类状态码是要尽可能的避免。

服务器向用户返回的状态码和提示信息

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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
502 网关错误
503 Service Unavailable 服务端当前无法处理请求
504 网关超时

URL 规范

域名

API与用户的通信协议，总是使用HTTPs协议。
应该尽量将API部署在专用域名之下 https://api.example.com
项目API比较简单的放在主域名下 https://example.com/api/

版本

应该将API的版本号放入URL

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

~~或将版本号放在HTTP头信息中 Accept Header：Accept: v1~~
~~自定义 Header； Github采用这种做法~~

命名

网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应
数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数
尽量不要用大写，单词间使用下划线'_'
url 层级大于或等于三层，则使用'?'带参数

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：删除某个指定动物园的指定动物
DELETE      /zoos/ID/animals?id=：删除某个指定动物园的指定动物

返回数据规范

返回错误格式

客户端错误，状态码是4xx，就应该向用户返回出错信息
错误代码根据 “状态码&错误码” 的方式返回。

{
    status:400,
    error_code:40006
    error: "Invalid API key"
}

错误码参考：
新浪错误码
 微信错误码
 豆瓣restful api 状态和错误码

** 返回结果格式 **

{
    status:200,
    data: []||{},
    msg:'提示信息'
}

** Hypermedia API **

RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。
Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。

{
current_user_url: "https://api.github.com/user",
current_user_authorizations_html_url: "https://github.com/settings/connections/applications{/client_id}",
authorizations_url: "https://api.github.com/authorizations",
code_search_url: "https://api.github.com/search/code?q={query}{&page,per_page,sort,order}",
commit_search_url: "https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}",
emails_url: "https://api.github.com/user/emails",
...

从上面可以看到，如果想获取当前用户的信息，应该去访问api.github.com/user，然后就得到了下面结果。

{
  "message": "Requires authentication",
  "documentation_url": "https://developer.github.com/v3"
}

上面代码表示，服务器给出了提示信息，以及文档的网址。

参考文章

RESTful API 设计指南
 微服务指南走北（三）：Restful API 设计简述
 RESTful API 规范 v1.0
网上整理的对于Rest和Restful api的理解

RESTful API 设计规范整理

HTTP 请求规范

HTTP 状态码

URL 规范

返回数据规范

参考文章

猜你喜欢

热点阅读