08 drf-自动生成接口文档 - 图1


一 自动生成接口文档

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

1.1. 安装依赖

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

  1. pip install coreapi

1.2. 设置接口文档访问路径

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

  1. from rest_framework.documentation import include_docs_urls
  2. urlpatterns = [
  3. ...
  4. path('docs/', include_docs_urls(title='站点页面标题'))
  5. ]

1.3. 文档描述说明的定义位置

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

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

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

  1. class BookListCreateView(generics.ListCreateAPIView):
  2. """
  3. get:
  4. 返回所有图书信息.
  5. post:
  6. 新建图书.
  7. """

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

  1. class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
  2. """
  3. list:
  4. 返回图书列表数据
  5. retrieve:
  6. 返回图书详情数据
  7. latest:
  8. 返回最新的图书数据
  9. read:
  10. 修改图书的阅读量
  11. """

1.4. 访问接口文档网页

浏览器访问 127.0.0.1:8000/docs/,即可看到自动生成的接口文档。
08 drf-自动生成接口文档 - 图2

如果遇到报错

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

两点说明:

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

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

  1. class StudentSerializer(serializers.ModelSerializer):
  2. class Meta:
  3. model = Student
  4. fields = "__all__"
  5. extra_kwargs = {
  6. 'age': {
  7. 'required': True,
  8. 'help_text': '年龄'
  9. }
  10. }