drf框架接口文档

0922自我总结

drf框架接口文档

rest framework可以自动帮助我们生成接口文档。

接口文档以网页的方式呈现。

自动接口文档能生成的是继承自apiview及其子类的视图。

一.安装依赖

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='站点页面标题'))
]

三.文档描述说明定义位置

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 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': '阅读量'
            }
        }