Web API接口
一、什么是Web API接口
通过网络,规定了前后台信息交互规则的url链接,也就是前后台信息交互的媒介
Web API接口和一般的url链接还是有区别的,Web API接口简单概括有下面四大特点
-
url:长得像返回数据的url链接
-
请求方式:get、post、put、patch、delete
- 采用get方式请求上方接口
-
请求参数:json或xml格式的key-value类型数据
- ak:6E823f587c95f0148c19993539b99295
- region:上海
- query:肯德基
- output:json
-
响应结果:json或xml格式的数据
- 上方请求参数的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"
}
...
]
}
二、接口文档的编写:YApi
YApi是去哪网大前端技术中心的一个开源可视化接口管理平台。
YApi项目可以搭建在任何本地或云服务器上,完成后台项目开发时的接口编写。为开发、测试等人员提供可视化的接口预览。
去哪同时在网上提供了YApi的测试网站:http://yapi.demo.qunar.com/,我们可以通过测试网站了解YApi是如何进行接口的编写的
1.访问测试网站
2.创建接口项目
3.创建接口
4.编写接口
5.设置请求参数
三、接口测试工具:Postman
Postman是一款接口调试工具,是一款免费的可视化软件,同时支持各种操作系统平台,是测试接口的首选工具。
Postman可以直接从官网:https://www.getpostman.com/downloads/下载获得,然后进行傻瓜式安装。
1.工作面板
2.简易的get请求
3.简易的post请求
4.请求百度地图接口
四、总结
- 接口四个核心部分
- 请求方式: eg:get获取数据,post增加数据
- 请求地址: 请求地址类似数据的url,https://api.map.baidu.com/place/v2/search
- 请求参数: 请求拼接的参数还是数据包参数
- 响应结果: 响应的状态码,状态信息和响应的数据
- 接口工具的使用
- 写接口文档的YApi平台,访问接口的Postman工具
- 接口文档:将接口的四个核心描述成文档
- Postman工具:测试接口的请求响应