自动生成接口文档

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

# 1 安装：pip install coreapi   # 2 在路由中配置     from rest_framework.documentation import include_docs_urls     urlpatterns = [         ...         path('docs/', include_docs_urls(title='站点页面标题'))     ] #3 视图类：自动接口文档能生成的是继承自APIView及其子类的视图。     -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:         修改图书的阅读量         """