自动生成接口文档

概述

　　在公司里，前端和后端是两拨人写，后端人，需要写出接口文档，给前端用，前端按照接口文档去开发

　　具体格式可以参照：https://open.weibo.com/wiki/2/comments/show

如何写

　　第一种：使用word或者md文档编写---纯手写--很多公司这么用

　　第二种：第三方平台录入---半手写---部分公司使用

　　　　　　参考资料：https://blog.csdn.net/weixin_44337261/article/details/121005675

　　第三种：公司自己开发接口平台，搭建接口平台---数据放在公司自己

　　　　　　参考资料：https://zhuanlan.zhihu.com/p/366025001

　　第四种：自动生成接口文档---用的少---自动生成+导出---》录入到yapi，有coreapi，swagger

coreapi使用

　　1、安装依赖

pip install coreapi

　　2、设置接口文档访问路径

from rest_framework.documentation import include_docs_urls

urlpatterns = [
    ...
    path('docs/', include_docs_urls(title='站点页面标题'))
]

　　3、文档描述说明的定义位置

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

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

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

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

    post:
    新建图书.
    """

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

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

    retrieve:
    返回图书详情数据

    latest:
    返回最新的图书数据

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

　　4、访问接口文档网页

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

 　　如果遇到报错

#AttributeError: 'AutoSchema' object has no attribute 'get_link'
REST_FRAMEWORK = {
 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
    # 新版drf schema_class默认用的是rest_framework.schemas.openapi.AutoSchema

}

　　两点说明

　　　　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': '年龄'
            }
        }