2022-09-1720:37:01后端程序开发Comments659 views字数 6329阅读模式

一. 什么是RESTful

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

二. RESTful API设计

API与用户的通信协议，总是使用HTTPs协议。
域名
- https://api.example.com 尽量将API部署在专用域名（会存在跨域问题）
- https://example.org/api/ API很简单
版本
- URL，如：https://api.example.com/v1/
- 请求头跨域时，引发发送多次请求
路径，视网络上任何东西都是资源，均使用名词表示（可复数）
- https://api.example.com/v1/zoos
- https://api.example.com/v1/animals
- https://api.example.com/v1/employees
method
- GET ：从服务器取出资源（一项或多项）
- POST ：在服务器新建一个资源
- PUT ：在服务器更新资源（客户端提供改变后的完整资源）
- PATCH ：在服务器更新资源（客户端提供改变的属性）
- DELETE ：从服务器删除资源
过滤，通过在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：指定筛选条件

状态码

文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

更多看这里：http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

错误处理，状态码是4xx时，应返回错误信息，error当做key。

1
2
3
{
error: "Invalid API key"
}

文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范。

GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档

Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。
- 1
  2
  3
  4
  5
  6
  {"link": {
    "rel":   "collection https://www.example.com/zoos",
    "href":  "https://api.example.com/zoos",
    "title": "List of zoos",
    "type":  "application/vnd.yourformat+json"
  }}

摘自：http://www.ruanyifeng.com/blog/2014/05/restful_api.html文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

三. 基于Django实现

路由系统：文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urlpatterns = [
    url(r'^users', Users.as_view()),
]

文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

CBV视图：文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

from django.views import View
from django.http import JsonResponse
 
class Users(View):
    def get(self, request, *args, **kwargs):
        result = {
            'status': True,
            'data': 'response data'
        }
        return JsonResponse(result, status=200)
 
    def post(self, request, *args, **kwargs):
        result = {
            'status': True,
            'data': 'response data'
        }
        return JsonResponse(result, status=200)

四. 基于Django Rest Framework框架实现

1. 基本流程

url.py文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

from django.conf.urls import url, include
from web.views.s1_api import TestView
 
urlpatterns = [
    url(r'^test/', TestView.as_view()),
]

views.py文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

from rest_framework.views import APIView
from rest_framework.response import Response
 
 
class TestView(APIView):
    def dispatch(self, request, *args, **kwargs):
        """
        请求到来之后，都要执行dispatch方法，dispatch方法根据请求方式不同触发 get/post/put等方法
         
        注意：APIView中的dispatch方法有好多好多的功能
        """
        return super().dispatch(request, *args, **kwargs)
 
    def get(self, request, *args, **kwargs):
        return Response('GET请求，响应内容')
 
    def post(self, request, *args, **kwargs):
        return Response('POST请求，响应内容')
 
    def put(self, request, *args, **kwargs):
        return Response('PUT请求，响应内容')

上述是rest framework框架基本流程，重要的功能是在APIView的dispatch中触发。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

2. 认证和授权

a. 用户url传入的token认证文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

b. 请求头认证文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

c. 多个认证规则文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

d. 认证和权限文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

e. 全局使用文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

上述操作中均是对单独视图进行特殊配置，如果想要对全局进行配置，则需要再配置文件中写入即可。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

settings.py

urls.py

views.py

3. 用户访问次数/频率限制

a. 基于用户IP限制访问频率文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

b. 基于用户IP显示访问频率（利于Django缓存）文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

settings.py

urls.py

views.py

c. view中限制请求频率文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

settings.py

urls.py

views.py

d. 匿名时用IP限制+登录时用Token限制文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

settings.py

urls.py

views.py

e. 全局使用文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

settings

4. 版本

a. 基于url的get传参方式文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

如：/users?version=v1文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

settings.py

urls.py

views.py

b. 基于url的正则方式文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

如：/v1/users/文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

settings.py

urls.py

views.py

c. 基于 accept 请求头方式文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

如：Accept: application/json; version=1.0文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

settings.py

urls.py

views.py

d. 基于主机名方法文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

如：v1.example.com文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

settings.py

urls.py

views.py

e. 基于django路由系统的namespace文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

如：example.com/v1/users/文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

settings.py

urls.py

views.py

f. 全局使用文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

settings.py

5. 解析器（parser）

根据请求头 content-type 选择对应的解析器就请求体内容进行处理。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

a. 仅处理请求头content-type为application/json的请求体文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

b. 仅处理请求头content-type为application/x-www-form-urlencoded 的请求体文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

c. 仅处理请求头content-type为multipart/form-data的请求体文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

upload.html

d. 仅上传文件文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

upload.html

e. 同时多个Parser文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

当同时使用多个parser时，rest framework会根据请求头content-type自动进行比对，并使用对应parser文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

f. 全局使用文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

settings.py

urls.py

views.py

注意：个别特殊的值可以通过Django的request对象 request._request 来进行获取文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

6. 序列化

序列化用于对用户请求数据进行验证和数据进行序列化。文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

a. 自定义字段文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

b. 基于Model自动生成字段文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

c. 生成URL文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

d. 自动生成URL文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

7. 分页

a. 根据页码进行分页文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urs.py

views.py

b. 位置和个数进行分页文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

c. 游标分页文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

8. 路由系统

a. 自定义路由文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

b. 半自动路由文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

c. 全自动路由文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

9. 视图

a. GenericViewSet文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

b. ModelViewSet（自定义URL）文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

c. ModelViewSet（rest framework路由）文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

urls.py

views.py

10. 渲染器

根据用户请求URL 或用户可接受的类型，筛选出合适的渲染组件。
用户请求URL：文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

http://127.0.0.1:8000/test/?format=json
http://127.0.0.1:8000/test.json

用户请求头：文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html

Accept:text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8

a. json文章源自菜鸟学院-https://www.cainiaoxueyuan.com/bc/27712.html