初识web API接口及Restful接口规范
一、web API接口
什么是web API接口?:
明确了请求方式,提供对应后台所需参数,请求url链接可以得到后台的响应数据
url : 返回数据的url
https://api.map.baidu.com/place/search
请求方式:
get,post,put,patch....
请求参数:json或xml格式的key-value类型数据
- ak:6E823f587c95f0148c19993539b99295
- region:上海
- query:肯德基
- output:json
响应结果:
返回json或xml格式的key-value类型数据
-
上方请求参数的output参数值决定了响应数据的格式
-
{ "status":0, "message":"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链接,同时根据规则制定请求方式,请求数据与响应结果
接口文档:
提供给前后台开发人员与测试人员查看
接口工具:
YAPI平台
专门写接口文档的YAPI平台 http://yapi.demo.qunar.com/
YApi是去哪儿网的前端技术中心的一个开源可视化接口管理平台。
- 创建接口项目
- 创建接口
- 编写接口
接口测试工具:Postman
Postman是一款接口调试工具,是一款免费的可视化软件,同时支持各种操作系统平台,是测试接口的首选工具。
Postman可以直接从官网:https://www.getpostman.com/downloads/下载获得,然后进行傻瓜式安装。
- 工作面板