Web API 接口规范

Posted 2020-11-22 小鸡

1.什么是Web API接口

通过网络，规定了前后台信息交互规则的url链接，也就是前后台信息交互的媒介Web API接口和一般的url链接还是有区别的，WebAPI接口简单概括有下面四大特点

• url：长得像返回数据的url链接

• 请求方式:get、post、put、patch、delete

  • 采用get方式请求上方接口

• 请求参数：json或xml格式的key-value类型数据

• 响应结果：json或xml格式的数据

  ?

2.接口文档的编写：YApi

YApi是去哪网大前端技术中心的一个开源可视化接口管理平台。

YApi项目可以搭建在任何本地货云服务器上面的，完成后端项目开发时候的接口编写。为开发、测试等人员提供可视化的接口规范。

YApi 官网 http://yapi.demo.qunar.com/

3.接口测试工具：Postman

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

Postman可以直接从官网获取https://www.getpostman.com/downloads/