Restful Api接口设计规范

2020-08-07 Jgw、无尘 1482次

1、使用Https协议作为Api和用户的通信协议

2、尽量为api分配一个专属的二级域名如:api.kaky.cn

3、将版本号放进api的url中会比放在请求头header中更为合适,如:http://api.kaky.cn/v2/


4、在Restful架构中,每个网址uri代表一种资源,所以网址中不要有动词,而且用到的名词往往和数据库中的表名相对应。

一般来说,数据库中的表都是同种记录的"集合",所以API中的名词也应该使用复数,如:http://api.kaky.cn/v2/members


5、对于资源的不同操作,通过http的不同请求方式来实现,常用的请求方式有如下四个:

GET:从服务器获取资源(一个或多个)

POST:在服务器增加资源

PUT:更新服务器上的资源

DELETE:删除服务器上的资源

可以发现,这四种请求方式和数据库的CURD操作相对应


下面列举一些例子

GET /members:列出所有会员

GET /members/{id}:获取某个指定会员的信息

POST /members:新建一个会员

PUT /members/{id}:更新某个指定会员的信息

DELETE /members/{id}:删除某个指定的会员


6、在实际情况中,我们很少会获取所有资源,而通常会进行排序、过滤、限制等,如:

?limit=10:指定返回记录的数量

?offset=10:指定返回记录的开始位置。

?page=2&per_page=10:指定第几页,以及每页的记录数。

?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。

?member_type_id=1:指定筛选条件


7、对于客服端发送的请求,api服务器应该对请求返回对应的状态码和状态码说明,对于状态码的设置可以参考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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。


1xx:信息,通信传输协议级信息。

2xx:成功,表示客户端的请求已成功接受。

3xx:重定向,表示客户端必须执行一些其他操作才能完成其请求。

4xx:客户端错误,此类错误状态代码指向客户端。

5xx:服务器错误,服务器负责这些错误状态代码。


当然,你也可以自定义状态码和描述。



8、服务器返回的数据格式应当使用json格式。


9、使用中划线 - ,而不是使用下划线 _ 来提高uri的可读性


10、在uri中使用小写字母


11、不要在末尾使用/,作为URI路径中的最后一个字符,正斜杠(/)不会添加语义值,并可能导致混淆。最好完全放弃它们。




声明:
1.本站的资源收集于互联网,仅供大家学习交流,请勿用于非法用途,否则后果自负!
2.如转载本站的原创文章,请勿必注明文章来源,对于不尊重原创的行为我们将追究责任