标签：lin list 新建 retrieve 详情 dem 接口文档 rest info
REST framework可以自动帮助我们生成接口文档。
接口文档以网页的方式呈现。
自动接口文档能生成的是继承自APIView及其子类的视图。
REST framewrok生成接口文档需要coreapi库的支持。
pip install coreapi
文档路由对应的视图配置为rest_framework.documentation.include_docs_urls，
参数title为接口文档网站的标题。
from rest_framework.documentation import include_docs_urls urlpatterns = [ ... path(‘docs/‘, include_docs_urls(title=‘站点页面标题‘)) ]
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 BookInfo(models.Model): ... bread = models.IntegerField(default=0, verbose_name=‘阅读量‘, help_text=‘阅读量‘) ...
或
class BookReadSerializer(serializers.ModelSerializer): class Meta: model = BookInfo fields = (‘bread‘, ) extra_kwargs = { ‘bread‘: { ‘required‘: True, ‘help_text‘: ‘阅读量‘ } }
注意 : 基于rese_framework序列化
接口文档工具 : http://yapi.demo.qunar.com/
标签：lin list 新建 retrieve 详情 dem 接口文档 rest info
原文地址：https://www.cnblogs.com/HZLS/p/11406520.html
