resuful API PHP接口规范

可以参考一下连接借鉴下其让的RESTFUL API 的规范文章
http://www.thinkphp.cn/topic/5023.html
https://www.imooc.com/article/17587
http://www.ruanyifeng.com/blog/2014/05/restful_api.html
https://www.cnblogs.com/luyucheng/p/6016801.html

App接口原理图
在这里插入图片描述
2、Restful WebApi
面向资源
①简介
一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。
RESTful应用

解决的问题

降低开发的复杂性
提高系统可伸缩性

②、规范
a、协议
API与用户的通信协议，总是使用http或https协议。
b、域名
应该尽量将API部署在专用域名下
例如：www.abc.com
c 、版本
应该将API的版本号放入URL,方便和直观
http://api.demo.com/v1
d、路径
路径又称"终点"（endpoint），表示API的具体网址
在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。
https://api.example.com/v1/users
e、HTTP动词
对于资源的具体操作，由HTTP动词表示

GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
DELETE（DELETE）：从服务器删除资源。
例下面的方式来操作和获取数据
GET /users：列出所有人员
GET /users/ID：获取某个指定人员的信息
POST /users：新建一个人员
PUT /users/ID：更新某个指定人员的信息
DELETE /users/ID：删除某个人员

f、过滤信息
如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回的结果

?limit=10：指定返回记录的数量
?page=2&per_page=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件

参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。
g、状态码
服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

h、错误处理
如果状态吗是4xx,就应该向用户返回出错信息，一般来说，返回的信息中将error作为键名，出错信息作为键值即可，json格式

{
"msg”=>"",
"status"=>200，
“data”=>json
}

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

GET /collection：返回资源对象的列表数组
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档

resuful API PHP接口规范

猜你喜欢