Web API接口

Posted 2020-11-22 生活很苦，但请一定坚持。

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Web API接口相关的知识，希望对你有一定的参考价值。

一、什么是Web API接口
- 接口的四个核心部分：
二、接口文档的编写：YApi
三、接口测试工具：Postman

一、什么是Web API接口

通过网络，规定了前后台信息交互规则的url链接，也就是前后台信息交互的媒介

Web API接口和一般的url链接还是有区别的，Web API接口简单概括有下面四大特点

接口的四个核心部分：

url：长得像返回数据的url链接
- https://api.map.baidu.com/place/v2/search
请求方式：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"
        }
        ...
	]
}