【1119 | Day62】Web API接口

目录

• 一、drf框架
• 二、接口
• 三、接口编写
• 四、接口文档
• 五、接口工具

一、drf框架

drf框架的主要作用：写接口

二、接口

定义：

明确了请求方式，提供对应后台所需参数，请求url链接可以得到后台的响应数据。

四大核心：

请求方式：get、post、put、patch、delete

请求地址：如https://api.map.baidu.com/place/v2/search

请求参数： ：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"
       }
       ...
       ]
  }
  

三、接口编写

参照某种规则(规范)书写url链接，同时根据规则制定请求方式，请求数据与响应结果。

四、接口文档

提供给前后台开发人员与测试人员查看。

五、接口工具

• 写接口文档的YApi平台：将接口的四个核心部分描述成文档。
• 访问接口的Postman工具：测试接口的请求响应。

具体操作可以参考： https://www.cnblogs.com/xiaoyuanqujing/articles/11869745.html