2.RESTful规范

API接口（ApplicationProgramInterface、程序之间的接口、程序之间的合约）

通过api接口可以实现计算机软件之间的相互通信，开发人员可以通过api接口程序开发应用程序，可以减少编写无用程序，减轻编程任务，api同时也是一种中间件，为各种不同平台提供数据共享

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

WebAPI接口的四大特点：

https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=上海&query=肯德基&output=json

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

Postman使用

# postman是模拟发送http请求的工具
# 解析json的网站
    http://www.json.cn/

请求头中User-Agent：客户端的类型

批量接口导出和测试

RESTful

什么是RESTful

REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客户端应用通过URL来获取资源的表征，获得这些表征致使这些应用转变状态
REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为“表征状态转移”
所有的数据，不过是通过网络获取的还是操作（增删改查）的数据，都是资源，将一切数据视为资源是REST区别与其他架构风格的最本质属性
对于REST这种面向资源的架构风格，有人提出一种全新的结构理念，即：面向资源架构（ROA：Resource Oriented Architecture）

RESTfu10条规范

抓包工具：fiddler，charles

# 1.数据的安全保障：url连接一般都采用https协议进行传输  注：采用https协议，可以提高数据交互过程中的安全性

# 2.接口特征表现，一看就知道是个api接口
    - 用api关键字标识接口url：
        - [https://api.baidu.com] (https://api.baidu.com/)
        - https://www.baidu.com/api
        注：看到api字眼，就代表该请求url链接是完成前后台数据交互的

# 3.多数据版本共存
    - 在url链接中标识数据版本
    - https://api.baidu.com/v1
    - https://api.baidu.com/v2
    注：url链接中的v1、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.响应状态码
    7.1 正常响应
        - 响应状态码2xx
        - 200：常规请求
        - 201：创建成功
    7.2 重定向响应
        - 响应状态码3xx
        - 301：永久重定向
        - 302：暂时重定向
   7.3 客户端异常
        - 响应状态码4xx
        - 403：请求无权限
        - 404：请求路径不存在
        - 405：请求方法不存在
    7.4 服务器异常
        - 响应状态码5xx
        - 500：服务器异常

# 8.错误处理，应返回错误信息，error当做key
    {
        error: "无权限操作"
    }    

# 9.返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范
    GET /collection：返回资源对象的列表（数组）
    GET /collection/resource：返回单个资源对象
    POST /collection：返回新生成的资源对象
    PUT /collection/resource：返回完整的资源对象
    PATCH /collection/resource：返回完整的资源对象
    DELETE /collection/resource：返回一个空文档

# 10.需要url请求的资源需要访问资源的请求链接
    # Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么
        {
            "status": 0,
            "msg": "ok",
            "results":[
                {
                    "name":"肯德基(罗餐厅)",
                    "img": "https://image.baidu.com/kfc/001.png"
                }
                ...
                ]
        }

基于Django实现

路由系统：

urlpatterns = [
    url(r'^users/$', views.Users.as_view()),
    url(r'^users2/$', views.user2),

]

View Code

视图函数：

import json

def  user2(request):
    if request.method=='GET':
        dic = {'status':200,'name': 'lqz2', 'age': 18}
        return HttpResponse(json.dumps(dic))
    elif request.method=='POST':
        dic = {'status': 200, 'msg': '修改成功'}
        return JsonResponse(dic)

class Users(View):
    def get(self, request):
        dic = {'status':200,'name': 'lqz', 'age': 18}
        return HttpResponse(json.dumps(dic))

    def post(self, request):
        dic = {'status': 200, 'msg': '修改成功'}
        return JsonResponse(dic)