接口规范

1、什么是web API接口

url:https://api.map.baidu.com/place/v2/search

"""
接口概念：前台与后台进行信息交互的媒介 - url链接

接口组成：四大特点
    url链接 - 长得像返回数据的url链接
    请求方式 - get(查)、post(增)、put(整体改)、patch(局部改)、delete(删)
    请求参数 - 拼接参数、数据包参数(urlencoded、form-data、json)
    响应结果 - 响应的json数据
"""

2、YApi

YApi是去哪儿网的一个开源可视化的接口管理平台

YApi项目可以搭建在任何本地或者云服务器上，完成后态项目开发时的接口编写。为开发、测试人员提供可视化的接口预览。同时提供了测试网站：http://yapi.demo.qunar.com/ ，我们可以先通过测试网站

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格式的数据

3、开发阶段接口测试工具

"""
Postman：
    官网下载、傻瓜式安装
"""

4、接口文档

"""
1）为什么要写接口文档
    为什么要写接口：作为后台开发者，要将后台数据通过url链接反馈给前台
    为什么要写文档：作为后台开发者，一定知道改url链接应该采用什么请求方式、提交哪些数据、返回了哪些结果
就像后台要将url链接改前台一样，前台知道应该访问什么链接，所以前台也应该知道采用什么请求方式，以及提交什么数据。
    换而言之，接口文档是给 后台开发者、前台开发者、测试等各个项目相关项目组同时查看的，方便团队开发（规则是后台指定的，文档后台来写）
    
2）编写文档
    i）采用word编写
    ii）drf框架有插件，可以根据cbv的类快速生成文档
    iii）采用写文档的平台
    
3）书写过程
    i）先安装开发需要，完成接口的开发（设置后台url链接，设置请求方式、请求数据、响应结果）
    ii）选择一个接口平台，将后台url链接，设置请求方式、请求数据、响应结果信息变成成文档即可
"""

5、接口规范

"""
1）为什么要指定接口规范
    在前后台分离情况下，后台可以采用不同的后台运用，开发出类似的功能，所以前后台请求响应的规则是一致的；如果安装一套标准来编写接口，后台不管是什么语言，前台都可以采用一样的方式进行交互。反过来，后台也不需要管前台到底采用何种方式请求（页面、工具、代码）
    
2）通用的接口规范：Restful接口规范 - 规定了url如何编写；请求方式的含义；响应的数据规则
    i）url编写
        https协议 - 保证数据安全性
        api字眼 - 标识操作的是数据
        v1、v2字眼 - 数据的不同版本共存
        资源复数 - 请求的数据称之为资源
        拼接条件 - 过滤群查接口数据（https://api.baidu.com/books/?limit=3&ordering=-price）
        
    ii）请求方式
        /books/ - get - 群查
        /books/(pk)/ - get - 单查
        /books/ - post - 单增
        /books/(pk)/ - put - 单整体改
        /books/(pk)/ - patch - 单局部改
        /books/(pk)/ - delete - 单删
    
    iii）响应结果
        网络状态码与状态信息：2xx | 3xx | 4xx | 5xx
        数据状态码：前后台约定规则 - 0:成功 1:失败 2:成功无结果
        数据状态信息：自定义成功失败的信息解释(英文)
        数据本体：json数据
        数据子资源：头像、视频等，用资源的url链接
"""