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

]

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

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:

修改图书的阅读量

"""

四 访问接口文档网页

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

两点说明：

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

}

}

drf频率源码、自动生成接口文档、JWT

目录 一.drf频率源码分析 二.自动生成接口文档 1 安装依赖 2 设置接口文档访问路径 3 文档描述说明的定义位置 4 访问接口文档网页 三.JWT 1 JWT基本原理 1.1 header 1. ...

drf框架接口文档

drf框架接口文档 REST framework可以自动帮助我们生成接口文档. 接口文档以网页的方式呈现. 自动接口文档能生成的是继承自APIView及其子类的视图. 一.安装依赖 pip insta ...

asp.net core使用Swashbuckle.AspNetCore(swagger)生成接口文档

asp.net core中使用Swashbuckle.AspNetCore(swagger)生成接口文档 Swashbuckle.AspNetCore:swagger的asp.net core实现 项 ...

asp.net core 使用 swagger 生成接口文档

参考地址:http://www.cnblogs.com/daxnet/p/6181366.html http://www.jianshu.com/p/fa5a9b76f3ed 微软参考文档:https ...

.net core 使用swagger自动生成接口文档

前言 swagger是一个api文档自动生动工具,还集成了在线调试. 可以为项目自动生成接口文档, 非常的方便快捷 Swashbuckle.AspNetCore 是一个开源项目,用于生成 ASP.N ...

Spring Boot(九)Swagger2自动生成接口文档和Mock模拟数据

一.简介 在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...

webapi 利用webapiHelp和swagger生成接口文档

webapi 利用webapiHelp和swagger生成接口文档.均依赖xml(需允许项目生成注释xml) webapiHelp:微软技术自带,仅含有模块.方法.请求-相应参数的注释. swagge ...

DRF之接口文档以及Xadmin

1. 自动生成接口文档 REST framework可以自动帮助我们生成接口文档. 接口文档以网页的方式呈现. 自动接口文档能生成的是继承自APIView及其子类的视图. 1.1. 安装依赖 REST ...

Spring boot 添加日志 和 生成接口文档

org.springframework.bootspring- ...

随机推荐

为什么使用Junit Test而不用普通java main方法来完成测试?

因为在程序里边,一个接口对应一个实现方法,而在接口中常常会定义相关的很多方法,所以在测试的时候,如果都在main方法里边进行测试,main方法就会显得臃肿,而且不便于以后其他人测试以及查看测试数据,用 ...

python3下载远程代码并执行

第一步: 先在gist之类的网站上贴上代码,目的不是高亮,而可以raw的形式获取代码,这样可以省掉处理html的时间,我这里用的是pasteraw: 远程上的代码:http://cdn.pastera ...

Angularjs学习笔记(五)----显示和格式化数据

一.引用指令 在AngularJS的文档中,所有指令的名字以驼峰命名法.而在模板中,则需要以蛇形命名法.可以以冒号分割(ng:model)或下划线分割(ng_model),更常见的是以ng-model ...

Linux下安装webstorm

Linux下安装webstorm 1--在webstorm官网里面下载最新的版本 WebStorm-11.0.3.tar.gz 2--创建webstorm的安装目录 #mkdir /usr/webst ...

ha_innobase::general_fetch

/***********************************************************************//** Reads the next or previ ...

arm linux上的第一个应用程序 BOA移植

1. 首先, linux在开发板上能跑起来了. 包括网络驱动也有了, ifconfig之后, 能看到在rcS里面设置的IP, 也能ping通windows主机了, 当然, 也要window关掉防火墙才 ...

g4e基础篇#2 Git分布式版本控制系统的优势

g4e 是 Git for Enterprise Developer的简写,这个系列文章会统一使用g4e作为标识,便于大家查看和搜索. 章节目录 前言 1. 基础篇: 为什么要使用版本控制系统 Git ...

UNIX网络编程——UDP编程模型

使用UDP编写的一些常见得应用程序有:DNS(域名系统),NFS(网络文件系统)和SNMP(简单网络管理协议). 客户不与服务器建立连接,而是只管使用sendto函数给服务器发送数据报,其中必须指定目 ...

jvm详情——5、选择合适的垃圾收集算法

回收器选择JVM给了三种选择:串行收集器.并行收集器.并发收集器,但是串行收集器只适用于小数据量的情况,所以这里的选择主要针对并行收集器和并发收集器. 默认情况下,JDK5.0以前都是使用串行收集器, ...

几种方法来实现scp拷贝时无需输入密码

欢迎转载!转载时请注明出处:http://blog.csdn.net/nfer_zhuang/article/details/42646849 前言 我在工作中经常要将一些文件传输到另外一个服务器上, ...