YApi 与 postman

YApi

一种接口文档编写工具

postman

一种接口测试工具

Restful接口规范

REST

Representational State Transfer（表属性状态转移）

核心：统一接口规范

规范

网络上的所有事物都被抽象为资源
每个资源都有一个唯一的资源标识符（books，cars）
同一个资源具有多种表现形式（xml 、json 等）
所有的操作都是无状态的
CRUP（POST GET PUT DELETE）

借口特征表现

用api关键字标识接口url：
https://api.baidu.com
https://www.baidu.com/api
注：看到api字眼，就代表该请求url链接是完成前后台数据交互的

数据即是资源

接口一般都是完成前后台数据的交互，交互的数据我们称之为资源
https://api.baidu.com/users
https://api.baidu.com/books
https://api.baidu.com/book
注：一般提倡用资源的复数形式，在url链接中奖励不要出现操作资源的动词，错误示范：https://api.baidu.com/delete-user

特殊的接口可以出现动词，因为这些接口一般没有一个明确的资源，或是动词就是接口
的核心含义
https://api.baidu.com/place/search
https://api.baidu.com/login

资源操作由请求方式决定

操作资源一般都会涉及到增删改查，我们提供请求方式来标识增删改查动作

https://api.baidu.com/books - get请求：获取所有书

https://api.baidu.com/books/1 - get请求：获取主键为1的书

https://api.baidu.com/books - post请求：新增一本书书

https://api.baidu.com/books/1 - put请求：整体修改主键为1的书

https://api.baidu.com/books/1 - patch请求：局部修改主键为1的书

https://api.baidu.com/books/1 - delete请求：删除主键为1的书

响应状态码

之前的博客已经写过了

响应结果

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

{
 "status": 0,
 "msg": "ok",
 "results":[
 {
 "name":"肯德基(罗餐厅)",
 "location":{
 "lat":31.415354,
 "lng":121.357339
 },
 "address":"月罗路2380号",
 "province":"上海市",
 "city":"上海市",
 "area":"宝山区",
 "street_id":"339ed41ae1d6dc320a5cb37c",
 "telephone":"(021)56761006",
 "detail":1,
 "uid":"339ed41ae1d6dc320a5cb37c"
 }
 ...
 ]
}

需要url请求的资源需要访问资源的请求链接

{
 "status": 0,
 "msg": "ok",
 "results":[
 {
 "name":"肯德基(罗餐厅)",
 "img": "https://image.baidu.com/kfc/001.png"
 }
 ...
 ]
}