接口规范

接口规范

什么是Web API接口

本质就是前后端分离后,进行信息交互的媒介, 也就是一个符合规范的url链接

Web API接口简单可以概括为下面四个特点:

1. url: 长得像返回数据的url链接
2. 请求方式: get, post, put, delete , patch...
3. 请求参数: 请求链接的时候携带的kv形式的参数
4. 响应结果: 请求完之后服务器返回的json等格式的数据

接口文档的编写: YApi

在我们的工作中, 我们是需要和其他同事交流的,对每个自己所写的接口的一个解释, 然后就可以使用YApi,一个开源的可视化的接口管理平台.

接口测试工具: Postman

Postman是一款接口调试工具, 是一款免费的可视化软件, 同时支持各种操作平台,是测试接口的首选工具.

Restful接口规范

URL设计

1. 数据的安全保障:
   url一般采用https协议进行传输,http协议是在http协议上封装的
2. 接口的表现特征:
   用api关键字标识接口
3. 多数据版本共存:
   在连接中可以标识数据的版本,
   https://api.baidu.com/v1
   https://api.baidu.com/v2
4. 数据即是资源:
   接口一般是完成前后台数据的交互, 交互的数据我们称之为资源,一般提倡资源的负数形式作为链接的设计,还有就是不可以出现操作资源的动词,但是特殊的也是可以出现动词的.
5. 资源操作用请求方式决定:
   get: 获取
   post: 增加
   put: 整体修改某一个数据
   patch: 局部修改某一个数据
   delete: 删除指定数据

响应状态码

200: 常规请求

201: 创建成功

301: 永久重定向

302: 暂时重定向

403: 请求无权限

404: 请求路径不存在

405: 请求方法不存在

500: 服务器异常

响应结果

响应的数据要有状态码, 状态信息,以及数据本身

{
    "status": 状态码,
    "msg": 状态信息,
    "results": { 响应数据 }
}