RESTfulAPI接⼝规范
RESTful规范
Restful API是⽬前⽐较成熟的⼀套互联⽹应⽤程序的API设计理念，Rest是⼀组架构约束条件和原则，如何Rest约束条件和原则的架构，我们就称为Restful架构，Restful架构具有结构清晰、符合标准、易于理解以及扩展⽅便等特点，受到越来越多⽹站的采⽤！
Restful API接⼝规范包括以下部分：
⼀、协议
API与⽤户的通信协议，总是使⽤HTTPs协议。
⼆、域名
三、版本
四、路径
五、HTTP动词
对于资源的具体操作类型，由HTTP动词表⽰，HTTP动词主要有以下⼏种，括号中对应的是SQL命令。
1. GET（SELECT）：从服务器取出资源（⼀项或多项）；
2. POST（CREATE）：在服务器新建⼀个资源；
3. PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）；
4. PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）；
5. DELETE（DELETE）：从服务器删除资源；
6. HEAD：获取资源的元数据；
7. OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。
六、过滤信息
如果记录数量很多，服务器不可能都将它们返回给⽤户，API会提供参数，过滤返回结果，常见的参数有：
1. ?limit=20：指定返回记录的数量为20；
2. ?offset=8：指定返回记录的开始位置为8；
3. ?page=1&per_page=50：指定第1页，以及每页的记录数为50；
4. ?sortby=name&order=asc：指定返回结果按照name属性进⾏升序排序；
5. ?animal_type_id=2：指定筛选条件。
七、状态码
服务器会向⽤户返回状态码和提⽰信息，以下是常⽤的⼀些状态码：
1. 200 OK - [GET]：服务器成功返回⽤户请求的数据；
2. 201 CREATED - [POST/PUT/PATCH]：⽤户新建或修改数据成功；
3. 202 Accepted - [*]：表⽰⼀个请求已经进⼊后台排队（异步任务）；
4. 204 NO CONTENT - [DELETE]：⽤户删除数据成功；
5. 400 INVALID REQUEST - [POST/PUT/PATCH]：⽤户发出的请求有错误，服务器没有进⾏新建或修改数据的操作；
6. 401 Unauthorized - [*]：表⽰⽤户没有权限（令牌、⽤户名、密码错误）；
7. 403 Forbidden - [*] 表⽰⽤户得到授权（与401错误相对），但是访问是被禁⽌的；
8. 404 NOT FOUND - [*]：⽤户发出的请求针对的是不存在的记录，服务器没有进⾏操作；
9. 406 Not Acceptable - [GET]：⽤户请求的格式不可得；
10. 410 Gone -[GET]：⽤户请求的资源被永久删除，且不会再得到的；
11. 422 Unprocesable entity - [POST/PUT/PATCH] 当创建⼀个对象时，发⽣⼀个验证错误；
12. 500 INTERNAL SERVER ERROR - [*]：服务器发⽣错误，⽤户将⽆法判断发出的请求是否成功。
⼋、错误处理
如果状态码是4xx，就会向⽤户返回出错信息，⼀般来说，返回的信息中将error作为键名，出错信息作为键值。
九、返回结果
针对不同操作，服务器向⽤户返回的结果应该符合以下规范：
1. GET /collection：返回资源对象的列表（数组）；
2. GET /collection/resource：返回单个资源对象；影视资源站采集api接口数据
3. POST /collection：返回新⽣成的资源对象；
4. PUT /collection/resource：返回完整的资源对象；
5. PATCH /collection/resource：返回完整的资源对象；
6. DELETE /collection/resource：返回⼀个空⽂档。
⼗、Hypermedia API
RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API⽅法，使得⽤户不查⽂档，也知道下⼀步应该做什么。
以上是Restful API设计应遵循的⼗⼤规范，除此之外，Restful API还需注意⾝份认证应该使⽤OAuth 2.0框架，服务器返回的数据格式，应该尽量使⽤JSON，避免使⽤XML。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。