Django API接口文档使用说明
Django API接口文档
REST framework可以自动帮助我们生成接口文档。
接口文档以网页的方式呈现。
自动接口文档能生成的是继承自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 = [...url(r'^docs/', include_docs_urls(title='API接口文档')) ]
3. 文档描述说明的定义位置
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:修改图书的阅读量"""
4. 访问接口文档网页
浏览器访问 127.0.0.1:8000/docs/,即可看到自动生成的接口文档。
两点说明:
1) 视图集ViewSet中的retrieve名称,在接口文档网站中叫做read
2)参数的Description需要在模型类或序列化器类的字段中以help_text选项定义,如:
class BookInfo(models.Model):...readcount= models.IntegerField(default=0, verbose_name='阅读量', help_text='阅读量')...
或
class BookSerializer(serializers.ModelSerializer): class Meta:model = BookInfofields = '__all__'extra_kwargs = {'readcount':{'help_text':'阅读量'}}
Django API接口文档使用说明相关推荐
- django rest framework 使用api接口文档
django rest framework 使用api接口文档 一.使用swagger生成api接口文档 二.使用drf自带的api接口文档 三.drf-yasg 一.使用swagger生成api接口 ...
- python生成api文档_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求 实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
- python api接口生成_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求 实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
- js学习总结----crm客户管理系统之项目开发流程和api接口文档
CRM ->客户管理系统 CMS ->内容发布管理系统 ERP ->企业战略信息管理系统 OA -> 企业办公管理系统 产品 / UI设计:需求分析,产品定位,市场调查...按 ...
- 开发日记-20190328 关键词 利用eolinker一键快速生成API接口文档
今天感觉效率真的很低= =各个层面的,apk发布到现场发现出现了问题,所以一个下午都在忙着解决现场出现的问题,领导一直打电话询问进度,午觉也没有睡所以今天预计的很多计划都处于停滞状态,像昨天规划的今天 ...
- 整合swagger2生成Restful Api接口文档
整合swagger2生成Restful Api接口文档 swagger Restful文档生成工具 2017-9-30 官方地址:https://swagger.io/docs/specificati ...
- api服务器开发语言,【API编写】介绍一个国内强大的API接口文档写作网站showdoc - 最好的编程语言 - 博客园...
这几天要写一个接口API文档,经理给我发过来一个,说要弄一个这样的接口文档,我一看,这可麻烦呀,有大纲有详细,我以为要用div+css去一个页面一个页面做呢,这工作量可不小,网站一搜索,竟然有可以直接 ...
- php怎么根据接口文档实现功能,CodeIgniter+swagger实现 PHP API接口文档自动生成功能...
一.安装swagger 1.首先需要有composer,没有的自行百度安装 2.下载swagger,打开网站https://packagist.org/packages/zircote/swagger ...
- echarts4离线使用文档_适合写API接口文档的管理工具有哪些?
现在越来越流行前后端分离开发,使用ajax交互.所以api接口文档就变的十分有意义了,目前市场有哪些比较优秀的接口文档管理工具呢? 1.MinDoc 网址:https://www.iminho.me/ ...
最新文章
- 自动运维PXE安装系统和DNS缓存解析
- tableau实战系列(九)-用 ZN 函数处理数据缺失点
- php mysql 表字段_php mysql获取表字段名称和字段信息的三种方法
- cf807 c 二分好题
- 【工作笔记】ElasticSearch —— 常用插件/工具汇总
- Windows Phone开发(46):与Socket有个约会 转:http://blog.csdn.net/tcjiaan/article/details/7669315...
- JavaScript 基础
- 算法题003 斐波那契(Fibonacci)数列
- vue.js能美化界面吗_美牙真的能变美吗?刘涛花百万美化牙齿,容貌大变样,网友:太神奇了吧...
- Java的二级动态菜单实现
- js打开新窗口 window.open() 隐藏菜单栏、工具栏,配置窗口大小、滚动条等
- 力扣刷题 | 二叉树专题
- 【Unity3D】游戏开发数学基础
- 把一个godaddy的域名转回国内的注册商
- 费用报销的一些管理软件怎么选?
- 模拟时针--微信小程序制作
- 解决浏览器“根据监管部门规定以及投诉举报,此链接违反相关法律法规,禁止访问”的策略
- hooks之useState和setEffect
- centos7下安装nginx
- 常见破解软件的优秀替代免费软件
热门文章
- 计算机中级职称什么时候出成绩,2021年上半年网络工程师成绩查询时间公布(7月12日),查询入口已开通!...
- 树莓派上使用python
- 常见的网络协议与网络要素的介绍
- AIR 3实现iOS下对H.264视频硬件解码
- nyoj 203 三国志(图论+dp)
- 计算机主板风扇安装,电脑cpu风扇怎么拆,cpu风扇安装,如何拆cpu风扇-中关村在线...
- 百度输入法重大BUG:内存占用随用户词库增大而暴涨
- autocad2016安装教程_CAD插件快速计算面积安装教程及资源链接
- 杭州儿童居住证续签(时间+入口)
- 概率论基础 - 7 - 特征函数