初识Django REST framework

1. RESTful接口定义
   1. 域名
      1. 每个API尽量放在一个专属域名（https://api.example.com）
      2. 如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。（https://example.org/api/）
   2. 版本
      1. 将版本放在URL中（https://api.example.com）
      2. 另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观
   3. 路径
      1. 资源作为网址，只能有名词，不能有动词，而且所用的名词往往与数据库的表名对应。
      2.  API中的名词应该使用复数。无论子资源或者所有资源。
   4. HTTP动词

      1. 常用的HTTP动词有下面四个（括号里是对应的SQL命令）。

         1. GET（SELECT）：从服务器取出资源（一项或多项）。
         2. POST（CREATE）：在服务器新建一个资源。
         3. PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
         4. DELETE（DELETE）：从服务器删除资源。

      2. 还有三个不常用的HTTP动词。

         1. PATCH（UPDATE）：在服务器更新(更新)资源（客户端提供改变的属性）。
         2. HEAD：获取资源的元数据。
         3. OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。
   5. 过滤信息
      1. 如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。
   6. 状态码（常见）
      1. 200 OK - [GET]：服务器成功返回用户请求的数据
      2. 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
      3. 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
      4. 204 NO CONTENT - [DELETE]：用户删除数据成功。
      5. 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作
      6. 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
      7. 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
      8. 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
      9. 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
      10. 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
      11. 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
      12. 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
   7. 错误信息
      1. 如果状态码是4xx，服务器就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。
   8. 返回结果
      1. GET /collection：返回资源对象的列表（数组）
      2. GET /collection/resource：返回单个资源对象
      3. POST /collection：返回新生成的资源对象
      4. PUT /collection/resource：返回完整的资源对象
      5. PATCH /collection/resource：返回完整的资源对象
      6. DELETE /collection/resource：返回一个空文档
   9. 其他
      1. 尽量返回JSON避免使用XML
2. DRF工程搭建
   1. 安装配置
      1. 依赖Django，以Django的扩展应用提供
      2. 安装

         pip install djangorestframework

      3. 添加rest_framework应用

         # 在settings.py的INSTALLED_APPS中添加'rest_framework'。
         
         INSTALLED_APPS = [
             ...
             'rest_framework',
         ]

   2. 创建序列化器

      class BookInfoSerializer(serializers.ModelSerializer):
          """图书数据序列化器"""
          class Meta:
              model = BookInfo
              fields = '__all__'
      
      """
      model 指明该序列化器处理的数据字段从模型类BookInfo参考生成
      fields 指明该序列化器包含模型类中的哪些字段，'__all__'指明包含所有字段
      
      """

   3. 编辑视图

      # 在子应用的views.py中创建视图BookInfoViewSet，这是一个视图集合
      
      from rest_framework.viewsets import ModelViewSet
      from .serializers import BookInfoSerializer
      from .models import BookInfo
      
      class BookInfoViewSet(ModelViewSet):
          queryset = BookInfo.objects.all()
          serializer_class = BookInfoSerializer
      
      """
      queryset 指明该视图集在查询数据时使用的查询集
      serializer_class 指明该视图在进行序列化或反序列化时使用的序列化器
      """
      

   4. 定义路由

      # 在booktest应用的urls.py中定义路由信息。
      
      from . import views
      from rest_framework.routers import DefaultRouter
      
      urlpatterns = [
          ...
      ]
      
      router = DefaultRouter()  # 可以处理视图的路由器
      router.register(r'books', views.BookInfoViewSet)  # 向路由器中注册视图集
      
      urlpatterns += router.urls  # 将路由器中的所以路由信息追到到django的路由列表中

3.