pythonrestfulapi接口规范_restfulapi应遵循哪些规范？

Restful API是目前比较成熟的一套互联网应用程序的API设计理念&＃xff0c;Rest是一组架构约束条件和原则&＃xff0c;如何Rest约束条件和原则的架构&＃xff0c;我们就称为Restful架构&＃xff0c;Restful架构具有结构清晰、符合标准、易于理解以及扩展方便等特点&＃xff0c;受到越来越多网站的采用&＃xff01;

Restful API接口规范包括以下部分&＃xff1a;

一、协议

API与用户的通信协议&＃xff0c;总是使用HTTPs协议。

二、域名

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

三、版本

可以将版本号放在HTTP头信息中&＃xff0c;也可以放入URL中&＃xff0c;如https://api.oldboyedu.com/v1/

四、路径

路径是一种地址&＃xff0c;在互联网上表现为网址&＃xff0c;在RESTful架构中&＃xff0c;每个网址代表一种资源(resource)&＃xff0c;所以网址中不能有动词&＃xff0c;只能有名词&＃xff0c;而且所用的名词往往与数据库的表格名对应。一般来说&＃xff0c;数据库中的表都是同种记录的"集合"(collection)&＃xff0c;所以API中的名词也应该使用复数&＃xff0c;如https://api.oldboyedu.com/v1/students。

五、HTTP动词

对于资源的具体操作类型&＃xff0c;由HTTP动词表示&＃xff0c;HTTP动词主要有以下几种&＃xff0c;括号中对应的是SQL命令。

1. GET(SELECT)&＃xff1a;从服务器取出资源(一项或多项)&＃xff1b;

2. POST(CREATE)&＃xff1a;在服务器新建一个资源&＃xff1b;

3. PUT(UPDATE)&＃xff1a;在服务器更新资源(客户端提供改变后的完整资源)&＃xff1b;

4. PATCH(UPDATE)&＃xff1a;在服务器更新资源(客户端提供改变的属性)&＃xff1b;

5. DELETE(DELETE)&＃xff1a;从服务器删除资源&＃xff1b;

6. HEAD&＃xff1a;获取资源的元数据&＃xff1b;

7. OPTIONS&＃xff1a;获取信息&＃xff0c;关于资源的哪些属性是客户端可以改变的。

六、过滤信息

如果记录数量很多&＃xff0c;服务器不可能都将它们返回给用户&＃xff0c;API会提供参数&＃xff0c;过滤返回结果&＃xff0c;常见的参数有&＃xff1a;

1. ?limit&＃61;20&＃xff1a;指定返回记录的数量为20&＃xff1b;

2. ?offset&＃61;8&＃xff1a;指定返回记录的开始位置为8&＃xff1b;

3. ?page&＃61;1&per_page&＃61;50&＃xff1a;指定第1页&＃xff0c;以及每页的记录数为50&＃xff1b;

4. ?sortby&＃61;name&order&＃61;asc&＃xff1a;指定返回结果按照name属性进行升序排序&＃xff1b;

5. ?animal_type_id&＃61;2&＃xff1a;指定筛选条件。

七、状态码

服务器会向用户返回状态码和提示信息&＃xff0c;以下是常用的一些状态码&＃xff1a;

1. 200 OK - [GET]&＃xff1a;服务器成功返回用户请求的数据&＃xff1b;

2. 201 CREATED - [POST/PUT/PATCH]&＃xff1a;用户新建或修改数据成功&＃xff1b;

3. 202 Accepted - [*]&＃xff1a;表示一个请求已经进入后台排队(异步任务)&＃xff1b;

4. 204 NO CONTENT - [DELETE]&＃xff1a;用户删除数据成功&＃xff1b;

5. 400 INVALID REQUEST - [POST/PUT/PATCH]&＃xff1a;用户发出的请求有错误&＃xff0c;服务器没有进行新建或修改数据的操作&＃xff1b;

6. 401 Unauthorized - [*]&＃xff1a;表示用户没有权限(令牌、用户名、密码错误)&＃xff1b;

7. 403 Forbidden - [*] 表示用户得到授权(与401错误相对)&＃xff0c;但是访问是被禁止的&＃xff1b;

8. 404 NOT FOUND - [*]&＃xff1a;用户发出的请求针对的是不存在的记录&＃xff0c;服务器没有进行操作&＃xff1b;

9. 406 Not Acceptable - [GET]&＃xff1a;用户请求的格式不可得&＃xff1b;

10. 410 Gone -[GET]&＃xff1a;用户请求的资源被永久删除&＃xff0c;且不会再得到的&＃xff1b;

11. 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时&＃xff0c;发生一个验证错误&＃xff1b;

12. 500 INTERNAL SERVER ERROR - [*]&＃xff1a;服务器发生错误&＃xff0c;用户将无法判断发出的请求是否成功。

八、错误处理

如果状态码是4xx&＃xff0c;就会向用户返回出错信息&＃xff0c;一般来说&＃xff0c;返回的信息中将error作为键名&＃xff0c;出错信息作为键值。

九、返回结果

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

1. GET /collection&＃xff1a;返回资源对象的列表(数组)&＃xff1b;

2. GET /collection/resource&＃xff1a;返回单个资源对象&＃xff1b;

3. POST /collection&＃xff1a;返回新生成的资源对象&＃xff1b;

4. PUT /collection/resource&＃xff1a;返回完整的资源对象&＃xff1b;

5. PATCH /collection/resource&＃xff1a;返回完整的资源对象&＃xff1b;

6. DELETE /collection/resource&＃xff1a;返回一个空文档。

十、Hypermedia API

RESTful API最好做到Hypermedia&＃xff0c;即返回结果中提供链接&＃xff0c;连向其他API方法&＃xff0c;使得用户不查文档&＃xff0c;也知道下一步应该做什么。

以上是Restful API设计应遵循的十大规范&＃xff0c;除此之外&＃xff0c;Restful API还需注意身份认证应该使用OAuth 2.0框架&＃xff0c;服务器返回的数据格式&＃xff0c;应该尽量使用JSON&＃xff0c;避免使用XML。