drf接口文档

接口文档

接口编写已经写完了,需要编写接口文档，给前端的人使用

-请求地址
-请求方式
-支持的编码格式
-请求参数(get,post参数)
-返回格式示例

在公司的写法

1）直接使用word或者md写
2）使用接口文档平台，在接口文档平台录入(Yapi（百度开源的自己搭建）,第三方平台(收费)，自己开发接口文档平台)

-https://www.showdoc.com.cn/item/index
- 不想花钱，没有能力开发，就使用开源的YAPI，   https://zhuanlan.zhihu.com/p/366025001

3）项目自动生成：swagger，coreapi

-1 下载：pip3 install coreapi
-2 路由中配置：
        from rest_framework.documentation import include_docs_urls
        urlpatterns = [
            path('docs/', include_docs_urls(title='站点页面标题'))
        ]
-3 在视图类中加注释
-4 在配置文件中配置
        REST_FRAMEWORK = {
         'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
        }

自动生成接口文档

REST framework可以自动帮助我们生成接口文档。
接口文档以网页的方式呈现。
自动接口文档能生成的是继承自APIView及其子类的视图

安装依赖

REST framewrok生成接口文档需要coreapi库的支持。

pip install coreapi

设置接口文档

在总路由中添加接口文档路径(注意在总路由中配)。
文档路由对应的视图配置为rest_framework.documentation.include_docs_urls，
参数title为接口文档网站的标题。

from rest_framework.documentation import include_docs_urls

urlpatterns = [
    ...
    path('docs/', include_docs_urls(title='站点页面标题'))
]
注意：新版本还需要在setting里的REST_FRAMEWORK里添加以下配置，否则会包‘get_link’这样字样的错误

'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',

文档描述说明的定义位置

单一方法的视图，可以直接使用类视图的文档字符串

class BookListView(generics.ListAPIView):
    """
    返回所有图书信息.
    """

包含多个方法的视图，在类视图的文档字符串中，分开方法定义

class BookListCreateView(generics.ListCreateAPIView):
    """
    get:
    返回所有图书信息.

    post:
    新建图书.
    """

对于视图集ViewSet，仍在类视图的文档字符串中封开定义，但是应使用action名称区分

class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
    """
    list:
    返回图书列表数据

    retrieve:
    返回图书详情数据

    latest:
    返回最新的图书数据

    read:
    修改图书的阅读量
    """

访问接口文档网页

浏览器访问 127.0.0.1:8000/docs/，即可看到自动生成的接口文档。

注意要点

1） 视图集ViewSet中的retrieve名称，在接口文档网站中叫做read
2）参数的Description需要在模型类或序列化器类的字段中以help_text选项定义

class Student(models.Model):
    ...
    age = models.IntegerField(default=0, verbose_name='年龄', help_text='年龄')
    ...

或

class StudentSerializer(serializers.ModelSerializer):
    class Meta:
        model = Student
        fields = "__all__"
        extra_kwargs = {
            'age': {
                'required': True,
                'help_text': '年龄'
            }
        }