c++ python混合编程 restful_python之路_rest-framework之初识RESTful API

'''1、域名

https://api.example.com 尽量将API部署在专用域名(会存在跨域问题)

https://example.org/api/ API很简单

2、版本

方式一：URL，如：https://api.example.com/v1/

方式二：请求头

跨域时，引发发送多次请求

3、名词：路径，视网络上任何东西都是资源，均使用名词表示(可复数)

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

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

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

4、请求方式

GET ：从服务器取出资源(一项或多项)

POST ：在服务器新建一个资源

PUT ：在服务器更新资源(客户端提供改变后的完整资源)

PATCH ：在服务器更新资源(客户端提供改变的属性)

DELETE ：从服务器删除资源

5、过滤：通过在url上传参的形式传递搜索条件

https://api.example.com/v1/zoos?limit=10：指定返回记录的数量

https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置

https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数

https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序

https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件

6、状态码

7、错误处理：状态码是4xx时，应返回错误信息，error当做key。

{

error: "Invalid API key"

}

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

GET /collection：返回资源对象的列表(数组)

GET /collection/resource：返回单个资源对象

POST /collection：返回新生成的资源对象

PUT /collection/resource：返回完整的资源对象

PATCH /collection/resource：返回完整的资源对象

DELETE /collection/resource：返回一个空文档

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

{"link": {

"rel": "collection https://www.example.com/zoos",

"href": "https://api.example.com/zoos",

"title": "List of zoos",

"type": "application/vnd.yourformat+json"

}}'''