Restful API最佳实践

吴哈哈系鹅

已于 2023-01-10 17:30:28 修改

阅读量88

点赞数

分类专栏： python-django 文章标签： restful 后端

于 2023-01-10 17:21:34 首次发布

本文链接：https://blog.csdn.net/weixin_46114766/article/details/128633466

版权

python-django 专栏收录该内容

5 篇文章 0 订阅

订阅专栏

1、协议

无序列表API与用户的通信协议，总是使用HTTPs协议。

2、域名

应该尽量将API部署在专用域名之下。
- https://api.example.com
如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。
- https://example.org/api/

3、版本

应该将API的版本号放入URL。
- https://api.exampe.com/v11

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

4、路径

路径又称"终点”( endpoint ) ，表示API的具体网址。
在RESTful架构中，每个网址代表一种资源（ resource ) ，所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合” ( collection)，所以API中的名词也应该使用复数。
举例来说，有一个API提供动物园（zoo )的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

5、HTTP动词

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

常用的HTTP动词有下面五个（括号里是对应的SQL命令)。
- GET ( SELECT):从服务器取出资源(一项或多项)。
- POST (CREATE):在服务器新建一个资源。
- PUT ( UPDATE)：在服务器更新资源(客户端提供改变后的完整资源)。
- PATCH( UPDATE)：在服务器更新资源(客户端提供改变的属性)。
  - 说明：http动词中，put代表全部更新，patch表示部分更新。
- DELETE ( DELETE)：从服务器删除资源。
还有两个不常用的HTTP动词。
- HEAD：获取资源的元数据。
- OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

6、过滤信息( Filtering )

如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。
- 下面是一些常见的参数。
  - ?limit=10:指定返回记录的数量
  - ?offset=10:指定返回记录的开始位置。
  - ?page=2&per_page=100:指定第几页,以及每页的记录数。
  - ?sortby=name&order=asc:指定返回结果按照哪个属性排序，以及排序顺序。
  - ?animal_type_id=1:指定筛选条件
- 状态码(Status Codes )
  - 服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词)。
  - 200 OK - [GET]:服务器成功返回用户请求的数据，该操作是幂等的（ldempotent)。
  - 201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
  - 202 Accepted -[*]:表示一个请求已经进入后台排队(异步任务)。
  - 204 NO CONTENT - [DELETE]:用户删除数据成功。
  - 400 INVALID REQUEST - [POST/PUT/PATCH]:410 Gone -[GET]:用户请求的资源被永久删除，且不会再得到的。
  - 401 Unauthorized - [*]:表示用户没有权限（令牌、用户名、密码错误)。
  - 403 Forbidden -[]表示用户得到授权（与401错误相对)，但是访问是被禁止的。404 NOT FOUND -[]:服务器上没有请求的资源。路径错误等。
  - 406 Not Acceptable - [GET]:用户请求的格式不可得（比如用户请求JSON格式，但是服务器返回的并非json格式的数据。
  - 410 Gone -[GET]:用户请求的资源被永久删除，且不会再得到的。
  - 422 Unprocesable entity - [POST/PUT/PATCH]当创建一个对象时，发生一个验证错误。
  - 500 INTERNAL SERVER ERROR -[*]:貌似内部资源出故障了。该状态码表明服务器端在执行请求时发生了错误。也有可能是web应用存在bug或某些临时故障。

7、错误处理( Error handling )，。

无序列表如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。
无序列表error: “Invalid APl key”

8、返回结果

针对不同操作，服务器向用户返回的结果应该符合以下规范。
GET /collection :返回资源对象的列表（数组)
GET /collection/resource:返回单个资源对象
POST /collection :返回新生成的资源对象
PUT /collection/resource:返回完整的资源对象
PATCH /collection/resource:返回完整的资源对象
DELETE /collection/resource:返回一个空文档

9、Hypermedia APl

无序列表RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。
比如，当用户向api.example.com的根目录发出请求，会得到这样一个文档。
无序列表上面代码表示，文档中有一个link属性，用户读取这个属性就知道下一步该调用什么API了。rel表示这个API与当前网址的关系（ collection关系，并给出该collection的网址），href表示API的路径，title表示API的标题，type表示返回类型。