搜索
简帛阁>技术文章>drf框架接口文档

drf框架接口文档

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': '阅读量'
            }
        }
目录接口文档在公司的写法自动生成接口文档安装依赖设置接口文档文档描述说明的定义位置访问接口文档网页注意要点回到顶部接口文档接口编写已经写完了,需要编写接口文档,给前端的人使用请求地址请求方式支持的编
ESTframework可以自动帮助我们生成接口文档接口文档以网页的方式呈现。自动接口文档能生成的是继承自APIView及其子类的视图。1安装依赖RESTframewrok生成接口文档需要core
绍drfspectacular是为DjangoRESTFramework生成合理灵活的OpenAPI30模式。它可以自动帮我们提取接口中的信息,从而形成接口文档,而且内容十分详细,再也不用为写接口
简介DRF(DjangoRESTframework)是构建RESTful风格的Webapi的强大而灵活的工具包。它是在Django框架基础之上,进行了二次开发。简称为DRF框架或RESTframewo
DRF框架安装配置及其功能概述Django与DRF源码视图解析DRF框架序列化和返序列化DRF框架serializers中ModelSerializer类简化序列化和反序列化操作DRF源码save以及
drf框架快速查询drf的安装和简单使用API接口与restful的10条规范序列化组件源码分析之序列化器的many关键字序列化类高级用法之source、SerializerMethodField和
一报错信息detail:CSRFFailed:CSRFcookienotset二解决办法方法一:在配置文件中配置REST_FRAMEWORK{'DEFAULT_AUTHENTICATION_CLASS
列化与反序列化一种对于数据的操作,将数据进行格式转换序列化操作:将python类型转换成json反序列化操作:将json转换成python类型DRF提供的功能:1序列化2视图3路由1安装DRF:pi
Swagger可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API。Swagger可以生成客户端SDK代码用于各种不同的平台上的实现。Swagger文件可以在许多不同的平台上从代码
API不可能一成不变,无论是新增或者删除已有API,都会对调用它的客户端产生影响。如果对API的增删没有管理,随着API的增增减减,调用它的客户端就会逐渐陷入迷茫,到底哪个API是可用的?为什么之前可