drf之自动生成接口文档

自动生成接口文档（3星）

前言

流程: 后端人员写好接口，编写接口文档，给前端人员看，前端人员依照接口文档开发

公司里的主流:

• 后端，使用world，md写，提到git上
• 公司有接口平台，后端开发在接口平台录入（yapi，第三方），可以批量导入
• 后端项目自动生成接口文档（不是特别美观或友好，有时候还需要配合上面两种）
  • -django的drf自动生成 coerapi，swagger：java，go，python

使用coreapi自动生成

安装依赖

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

pip3 install coreapi

设置接口文档访问路径

在总路由中添加接口文档路径。

文档路由对应的视图配置为rest_framework.documentation.include_docs_urls，

参数title为接口文档网站的标题。

from rest_framework.documentation import include_docs_urls

urlpatterns = [
    ...
    path('docs/', include_docs_urls(title='站点接口'))
]

访问接口文档网页

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

如果遇到报错:

在settings.py文件内

REST_FRAMEWORK = {
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
    # 新版drf schema_class默认用的是rest_framework.schemas.openapi.AutoSchema
}
# 哪个不行就换另一个

文档描述说明的定义位置

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

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

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

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

    post:
    新建图书.
    """

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

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

    retrieve:
    返回图书详情数据

    latest:
    返回最新的图书数据

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

两点说明：

1） 视图集ViewSet中的retrieve名称，在接口文档网站中叫做read

2）参数的Description需要在模型类或序列化器类的字段中以help_text选项定义，如：

class Book(models.Model):
    title = models.CharField(max_length=32, help_text='必须为字符串')

或

class BookModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = '__all__'
        extra_kwargs = {'title': {'help_text': '必须为字符串'}, 'price': {'help_text': '必须是数字'}}

其他: