什么是 restful 规范？

 

一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。

一、协议

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

　　什么是https协议

二、域名

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


https://api.example.com

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


https://example.org/api/

三、版本（Versioning）

应该将API的版本号放入URL。


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

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

　　http://www.luffycity.com/api/v1/salary

　　http://www.luffycity.com/api/v2/salary

　    https://v4.bootcss.com

　　https://v3.bootcss.com

四、路径（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：删除某个指定动物园的指定动物

如果记录数量很多，服务器不可能都将它们返回给用户。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 的含义是相同的。

七、状态码（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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

详细：　

GET：通过URL网址传递客户端与服务器之间的消息传递使用，
POST: 可以给服务器提交数据，是一种比较流行的，安全的的数据传递
PUT: 请求服务器存储一个资源，通常指定存储的位置
DELETE:请求服务器删除一个资源
HEAD:请求获取对应的HTTP抱头信息
OPTIONS:可以获取当前URL所支持的请求类型
100-------客户必须继续发出请求
101-------客户要求服务器根据请求转换Http协议版本
200-------访问成功
201-------提示知道新文件的url
202-------接受和处理，但处理未完成
203-------返回信息不准确或不完整
204-------请求收到，但返回信息为空
205-------服务器完成了请求，用户代理必须复位当前已经浏览过的文件
206-------服务器已完成了部分用户的GTP请求
300-------（多种选择）  服务器根据请求可执行多种操作
。服务器可根据请求者 来选择一项操作，或提供操作列表供其选择。
301-------删除请求数据
302-------在其他地址发现了请求数据
303-------建议客户访问其他URL或访问方式
304-------客户端已经执行get，但文件未变化
305-------请求的资源必须从服务器指定的地址获得
306-------前一版本HTTP中使用的代码，现在版本不能用
307-------申明请求的资源临时性删除
400-------错误请求，如语法错误
401-------请求授权失败
402-------保留有效CharaeTo头相应
403-------请求不允许
404-------没有发现文件，查询或URI
405-------用户在Request-Line字段定义的方法不允许
406-------根据用户发送的Accept拖，请求资源不可访问
407-------类似401，用户必须首先在代理服务器上的到授权
408-------客户端没有在用户指定的时间内完成请求
409-------对当前资源状态，请求不能完成
410-------服务器上不能有此资源且无法进一步的参考地址
411-------服务器拒绝用户定义的Content-Length属性请求
412-------一个或多个请求头字段在当前请求中错误
413-------请求的资源大于服务器允许的大小
414-------请求的资源URL长于服务器允许的长度
415-------请求资源不支持请求项目格式
416-------请求中包含Range请求头字段，在当前请求资源范围内没有range指定值
,请求也不包含If-Range请求头字段
417-------服务器不满足请求Expect头字段指定的期望值，如果是代理服务器
，可能是下一级服务器不能满足请求
500-------服务器发生内部错误
501-------服务器不支持请求的函数
502-------服务器暂时不可用，有时是为了防止发生系统过载
503-------服务器过载或暂时维修
504-------关口过载，服务器使用另一个关口或服务器来响应用户
，等待时间设定值较长
505------服务器不支持拒绝值请头中指定的HTTP版本
————————————————

return HttpResponse("adasdsa',status=300)

八、错误处理（Error handling）

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


{
    error: "Invalid API key"
}

{

　　code:100001,

　　error: 'xxx错误‘’,

}

九、返回结果

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

  • 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的根目录发出请求，会得到这样一个文档。


{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}

上面代码表示，文档中有一个link属性，用户读取这个属性就知道下一步该调用什么API了。

rel表示这个API与当前网址的关系（collection关系，并给出该collection的网址），

href表示API的路径，title表示API的标题，type表示返回类型。

Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。


{
  "current_user_url": "https://api.github.com/user",
  "authorizations_url": "https://api.github.com/authorizations",
  // ...
}

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


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

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

【推广】 免费学中医，健康全家人
原文地址：https://www.cnblogs.com/Rivend/p/11947319.html