我们在实际项目中，会需要将我们的一些接口的信息返回给前端，便于前后端的交互，在实际使用中，这种自动生成接口文档的模块很多，我主要是用REST framework自动生成接口文档，这个需要用到的是coreapi库的支持，具体使用如下所示
前言：接口文档是以网页的方式呈现，自动接口文档能生成的是继承了APIView及其子类的视图，继承了其他的则不能自动使用这个生成。
一、安装依赖
pip install -i https://pypi.douban.com/simple/ coreapi
二、设置接口文档访问路径
在总路由中添加接口文档路径，参数title为接口文档网站的标题。
from rest_framework.documentation import include_docs_urls urlpatterns = [ ... url(‘docs/‘, include_docs_urls(title=‘站点页面标题‘)) ]
三、文档描述说明的定义位置
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: 修改图书的阅读量 """
在这些都完成以后，我们使用浏览器直接访问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‘: ‘年龄‘ } }
原文：https://www.cnblogs.com/mcc61/p/11177950.html