python之路67 drf从入门到成神 8 接口文档、jwt介绍和原理、drf-jwt快速使用、定制返回格式、jwt的认证类

接口文档

前后端分离
    我们做后端，写接口
    前端做前端，根据接口写app、pc、小程序

    作为后端来讲、我们很清楚，比如登录接口 /api/v1/login/ ----》post-------》username，password编码方式json----》返回的格式{code：100，msg：登录成功}

    后端人员、接口写完、一定要写接口文档

接口文档如何编写
    1.使用word，md 编写接口文档
    2.使用第三方平台，编写我们的接口文档(非常多)------》收费
      https://www.showdoc.com.cn/item/index
    3.公司自己使用第三方开源的搭建的----》Yapi---》如果想自己搭建
      https://zhuanlan.zhihu.com/p/366025001
    4.使用drf编写的接口，可以自动生成接口文档
       swagger ----》drf-yasg----》官方推荐使用
       coreapi----


使用coreapi自动生成接口文档步骤
    1.安装
    2.配置路由
      from rest_framework.documentation import include_docs_urls
       path('docs/',include_docs_urls(title='xxx项目接口文档'))
     3.在视图类，方法上，写注释即可 
         在类上加注释
         在类的方法上加注释
         在序列化类或表模型的字段上加help_text，required。。。。
   
      4.配置文件配置
          REST_FRAMEWORK = {
     'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
    }