-drf-自动生成接口文档

REST framewor可以自动帮助我们生成接口文档

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

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

1 安装依赖

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

pip install coreapi

2 设置接口文档访问路径

在总路由中添加接口路径

文档路由对应的视图配置为 rest_framework.documentation.include_docs_urls

参数title为接口文档网站的标题

from rest_framework.documentation import include_docs_urls

urlpatterns = [
    ...
    path('docs/', include_docs_urls(title='站点页面标题'))
]

3 文档描述说明的定义位置

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

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

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

class BookListCreateView(generics.ListCreateAPIView):
    """
    get:
    返回所有图书信息.

    post:
    新建图书.
    """

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

class PublishInfo(ModelViewSet):
    '''
    list: 出版社列表
    create: 创建出版社
    retrieve: 出版社详情
    update: 更新出版社
    delete: 删除出版社
    '''

4 访问接口文档页面

浏览器访问 127.0.0.1:8000/docs/，即可看到自动生成的接口文档。

如果遇到报错

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

}

两点说明

• 视图集ViewSet中的retrieve名称(作用查看单条数据详情)，在接口文档网站中叫做read
• 参数的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': '年龄'
            }
        }

5 封装Response对象

1 以后都使用自己封装的response
class APIResponse(Response):
    def __init__(self, code=100, msg='成功', data=None, status=None, headers=None, content_type=None, **kwargs):
        dic = {'code': code, 'msg': msg}
        if data:
            dic['data'] = data

        dic.update(kwargs) # 这里使用update
        super().__init__(data=dic, status=status,   
                         # 重写了父类的实例化参数，让他的值与子类一样
                         template_name=None, headers=headers,
                         exception=False, content_type=content_type)
2 使用：
	return APIResponse(code=100,msg='查询成功',data=ser.data,count=200,next='http://wwwa.asdfas')