请扫码加微信



7*24小时服务热线

4006-371-371

关注微信公众号

Restful Api设计规范

分类 智能建站帮助 阅读677 次 发布日期 2021-03-01

RESTful简介

RESTFUL是一种网络应用程序的设计风格和开发方式,基于HTTP,可以使用XML格式定义或JSON格式定义。RESTFUL适用于移动互联网厂商作为业务接口的场景,实现第三方OTT调用移动网络资源的功能,动作类型为新增、变更、删除所调用资源。

一、Api和用户的通信协议:https.

二、在Restful架构中,每个网址uri代表一种资源,用到的名词往往和数据库中的表名相对应。

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

三、常用的请求方式有如下四个:

GET:从服务器获取资源(一个或多个),例如GET /members:列出所有会员GET /members/{id}:获取某个指定会员的信息

POST:在服务器增加资源,POST /members:新建一个会员

PUT:更新服务器上的资源,PUT /members/{id}:更新某个指定会员的信息

DELETE:删除服务器上的资源,DELETE /members/{id}:删除某个指定的会员

这四种请求方式和数据库的CURD操作相对应。

四、对于客服端发送的请求,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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

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