标签：域名 风格 条件 code lin 完整 auth int ccf
什么是restful?
RESTful与技术无关，它代表的是一种软件架构风格,REST是Representational State Transfer的简称，中文翻译为“表征状态转移”或“表现层状态转化”。
RESTul API的设计规范
一 API与用户的通讯协议
1，总是使用HTTPs协议。
二域名
2, 尽量将API部署在专用域名
三体现版本号
3: 版本
1. 将版本信息放在URL中，如：https://api.example.com/v1/
2. 将版本信息放在请求头中。
四路径使用名词
4,视网络上任何东西都是资源，均使用名词表示（可复数）
https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees
五HTTP请求方式
5, 对于资源的具体操作类型，由HTTP动词表示。
常用的HTTP动词有下面四个（括号里是对应的SQL命令）。
GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
DELETE（DELETE）：从服务器删除资源。
六过滤信息
6, 如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。
下面是一些常见的参数。
?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?producy_type=1：指定筛选条件
七 ,状态码（Status Codes）
服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。
八、错误处理（Error handling）
如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。
九、返回结果
针对不同操作，服务器向用户返回的结果应该符合以下规范。
RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。注：Github就是这么做的
其他：服务器返回的数据格式，应该尽量使用JSON，避免使用XML。
标签：域名 风格 条件 code lin 完整 auth int ccf
原文地址：https://www.cnblogs.com/yzxing/p/9665079.html
