一API接口

# 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格式的数据
        http响应-->响应状态码-->响应头-->响应体(json)

# 前后端交互的三种编码格式
urlencoded:正常的post请求提交数据:name=ldb&age=18
formdata:post请求上传文件:带文件二进制形式
json:body体中的数据格式为:{"name":"ldb","age":18}

二restful规范

# 前后端交互使用api接口---》符合某种规范---》restful规范---》写前后端分离的标准
# REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征性状态转移）。 它首次出现在2000年Roy Fielding的博士论文中。
RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中
# 10条内容
1.数据的安全保障
    通常使用https协议进行传输，提高数据交互过程中的安全性
2.用api关键字标识接口，看到api字眼，就代表该请求url链接是完成前后端数据交互的
    https://api.baidu.com
    https://www.baidu.com/api
3.多数据版本共存，在url链接中标识数据版本
    https://api.baidu.com/v1
    https://api.baidu.com/v2
4.数据即是资源，均使用名词(可复数)
    接口一般都是完成前后台数据交互的，交互的数据我们称之为资源
    https://api.baidu.com/users
    https://api.baidu.com/books
    https://api.baidu.com/book
    注：一般提倡用资源的复数形式，在url链接中奖励不要出现操作资源的动词，错误示范：https://api.baidu.com/delete-user
    特殊的接口可以出现动词，因为这些接口一般没有一个明确的资源，或是动词就是接口的核心含义
    https://api.baidu.com/place/search
    https://api.baidu.com/login
5.资源操作由请求方式决定(method)
    操作资源一般都会涉及到增删改查，我们提供请求方式来标识增删改查动作
    https://api.baidu.com/books - get请求：获取所有书
    https://api.baidu.com/books/1 - get请求：获取主键为1的书
    https://api.baidu.com/books - post请求：新增一本书书
    https://api.baidu.com/books/1 - put请求：整体修改主键为1的书
    https://api.baidu.com/books/1 - patch请求：局部修改主键为1的书
    https://api.baidu.com/books/1 - delete请求：删除主键为1的书
6.请求地址中带过滤条件，通过在url上传参的形式传递搜索条件
    https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
    https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
    https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
    https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
    https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件
7.响应状态码(http的响应状态码，响应体的json数据中带状态码)
    http的响应状态码
    1xx:请求正在处理
    2xx:请求成功(200,201)
    3xx:重定向(301,302)
    4xx:客户端错误(404:地址不存在，403:禁止了)
    5xx:服务端错误
    响应体中返回json格式数据-->code,status-->也有状态码-->服务端自定义的
    1001:用户名错误
    1002:没有权限
8.错误处理，应返回错误信息
    返回数据是json格式-->带状态码-->错误信息
    {
        error:"无权限操作"
    }
9.返回结果，针对不同操作，服务器向用户返回的结果应符合以下规范
    GET /collection：返回资源对象的列表（数组） [{name:lqz,age:19},{name:pyy,age:33}]
    GET /collection/resource：返回单个资源对象 {name:lqz,age:19}
    POST /collection：返回新生成的资源对象 
    PUT /collection/resource：返回完整的资源对象
    PATCH /collection/resource：返回完整的资源对象
    DELETE /collection/resource：返回一个空文档
10.返回资源中链接地址
    # Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么
    {
        "status": 0,
        "msg": "ok",
        "results":[
            {
                "name":"肯德基(罗餐厅)",
                "img": "https://image.baidu.com/kfc/001.png"
            }
            ...
            ]
    }
    
# 比较好的接口返回
    # 响应数据要有状态码、状态信息以及数据本身
    {
        "status": 0,
        "msg": "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"
            }
            ...
            ]
    }

三接口测试工具postman

# 对接口进行测试---》在浏览器中只能发送get请求，发不了post，delete..
# 接口测试工具：mac，win，linux都可以
# 使用最多的软件：postman ---》后来慢慢收费了---》Postwoman
​
# 下载地址：https://www.getpostman.com/downloads/

四序列化

api接口开发，最核心最常见的一个过程就是序列化，所谓序列化就是把数据转换格式，序列化可以分两个阶段:
    序列化:把我们识别的数据转换成指定的格式提供给别人(转换成json格式)
    反序列化:把别人提供的数据转换/还原成我们需要的格式(前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中)