Django restful framework生成API文档过程详解


Posted in Python onNovember 12, 2020

自动生成api文档(不管是函数视图还是类视图都能显示)

1.安装rest_framework_swagger库

pip install django-rest-swagger

2.在项目下的 urls.py 中加入如下:

from rest_framework_swagger.views import get_swagger_view
schema_view = get_swagger_view(title='API文档')
urlpatterns += [
  path(r'docs/', schema_view),
]

3.在创建的django项目下的settings中加入如下:

INSTALLED_APPS = ['rest_framework_swagger']

REST_FRAMEWORK = {
  'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.AutoSchema'
}

4、生成的api文档界面如下:

Django restful framework生成API文档过程详解

5、DRF访问接口自带的界面如下:

Django restful framework生成API文档过程详解

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
在Python中实现贪婪排名算法的教程
Apr 17 Python
python使用分治法实现求解最大值的方法
May 12 Python
Python中unittest模块做UT(单元测试)使用实例
Jun 12 Python
Python简单获取自身外网IP的方法
Sep 18 Python
python模块smtplib学习
May 22 Python
Windows系统下PhantomJS的安装和基本用法
Oct 21 Python
调试Django时打印SQL语句的日志代码实例
Sep 12 Python
Python基于Tensor FLow的图像处理操作详解
Jan 15 Python
Python collections模块的使用方法
Oct 09 Python
使用Python快速打开一个百万行级别的超大Excel文件的方法
Mar 02 Python
python内置进制转换函数的操作
Jun 02 Python
Python爬虫网络请求之代理服务器和动态Cookies
Apr 12 Python
Python通过Schema实现数据验证方式
Nov 12 #Python
Django用户认证系统如何实现自定义
Nov 12 #Python
Django自带用户认证系统使用方法解析
Nov 12 #Python
Django多数据库联用实现方法解析
Nov 12 #Python
Django数据库迁移常见使用方法
Nov 12 #Python
python爬虫中PhantomJS加载页面的实例方法
Nov 12 #Python
python调用win32接口进行截图的示例
Nov 11 #Python
You might like
php一维二维数组键排序方法实例总结
2014/11/13 PHP
PHP操作文件的一些基本函数使用示例
2014/11/18 PHP
PHP的Socket网络编程入门指引
2015/08/11 PHP
PHP中如何使用session实现保存用户登录信息
2015/10/20 PHP
PHP中对数组的一些常用的增、删、插操作函数总结
2015/11/27 PHP
Laravel框架生命周期与原理分析
2018/06/12 PHP
ThinkPHP框架下微信支付功能总结踩坑笔记
2019/04/10 PHP
php5.3/5.4/5.5/5.6/7常见新增特性汇总整理
2020/02/27 PHP
用javascript获得地址栏参数的两种方法
2006/11/08 Javascript
Firefox outerHTML实现代码
2009/06/04 Javascript
DOM Scripting中的图片切换[兼容Firefox]
2010/06/12 Javascript
Prototype源码浅析 Enumerable部分(二)
2012/01/18 Javascript
JavaScript运算符小结
2015/06/03 Javascript
JavaScript中的Promise使用详解
2015/06/24 Javascript
原生js仿jquery实现对Ajax的封装
2016/10/04 Javascript
JavaScript实现大图轮播效果
2017/01/11 Javascript
jQuery EasyUI 组件加上“清除”功能实例详解
2017/04/11 jQuery
浅谈react.js 之 批量添加与删除功能
2017/04/17 Javascript
three.js实现3D影院的原理的代码分析
2017/12/18 Javascript
用Vue编写抽象组件的方法
2019/05/06 Javascript
[01:04:49]KG vs LGD 2019国际邀请赛小组赛 BO2 第二场 8.15
2019/08/16 DOTA
详解Python中的序列化与反序列化的使用
2015/06/30 Python
python中redis的安装和使用
2016/12/04 Python
利用Pandas 创建空的DataFrame方法
2018/04/08 Python
python2.7实现FTP文件下载功能
2018/04/15 Python
关于python多重赋值的小问题
2019/04/17 Python
Django组件content-type使用方法详解
2019/07/19 Python
Python递归求出列表(包括列表中的子列表)的最大值实例
2020/02/27 Python
马来西亚最好的婴儿商店:Motherhood
2017/09/14 全球购物
欧姆龙医疗欧洲有限公司:Omron Healthcare Europe B.V
2020/06/13 全球购物
电子商务专业毕业生求职信
2014/06/12 职场文书
计算机毕业大学生求职信
2014/06/26 职场文书
优秀教师先进个人事迹材料
2014/08/31 职场文书
教师个人年度总结
2015/02/11 职场文书
三八妇女节慰问信
2015/02/14 职场文书
2015年幼儿园班主任工作总结
2015/05/12 职场文书