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中让MySQL查询结果返回字典类型的方法
Aug 22 Python
Python 探针的实现原理
Apr 23 Python
Python 中的range(),以及列表切片方法
Jul 02 Python
python树莓派红外反射传感器
Jan 21 Python
Python使用MyQR制作专属动态彩色二维码功能
Jun 04 Python
Python程序暂停的正常处理方法
Nov 07 Python
Python3常用内置方法代码实例
Nov 18 Python
python构造IP报文实例
May 05 Python
Python中random模块常用方法的使用教程
Oct 04 Python
opencv+pyQt5实现图片阈值编辑器/寻色块阈值利器
Nov 13 Python
Python selenium的这三种等待方式一定要会!
Jun 10 Python
Python中Schedule模块使用详解 周期任务神器
Apr 19 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
一个目录遍历函数
2006/10/09 PHP
使用php+swoole对client数据实时更新(一)
2016/01/07 PHP
php文件包含目录配置open_basedir的使用与性能详解
2017/04/03 PHP
TP5.0框架实现无限极回复功能的方法分析
2019/05/04 PHP
解决 firefox 不支持 document.all的方法
2007/03/12 Javascript
IE6/7 and IE8/9/10(IE7模式)依次隐藏具有absolute或relative的父元素和子元素后再显示父元素
2011/07/31 Javascript
如何让浏览器支持jquery ajax load 前进、后退功能
2014/06/12 Javascript
处理文本部分内容的TextRange对象应用实例
2014/07/29 Javascript
js实现的类似于asp数据字典的数据类型代码实例
2014/09/03 Javascript
谷歌浏览器不支持showModalDialog模态对话框的解决方法
2014/09/22 Javascript
bootstrap是什么_动力节点Java学院整理
2017/07/14 Javascript
详解webpack3如何正确引用并使用jQuery库
2017/08/26 jQuery
laravel5.3 vue 实现收藏夹功能实例详解
2018/01/21 Javascript
vue实现条件判断动态绑定样式的方法
2018/09/29 Javascript
详解vue的双向绑定原理及实现
2019/05/05 Javascript
vue中使用element ui的弹窗与echarts之间的问题详解
2019/10/25 Javascript
基于Vue.js+Nuxt开发自定义弹出层组件
2020/10/09 Javascript
python将多个文本文件合并为一个文本的代码(便于搜索)
2011/03/13 Python
跟老齐学Python之关于循环的小伎俩
2014/10/02 Python
python开发中range()函数用法实例分析
2015/11/12 Python
django 修改server端口号的方法
2018/05/14 Python
python实现对求解最长回文子串的动态规划算法
2018/06/02 Python
python快排算法详解
2019/03/04 Python
关于numpy数组轴的使用详解
2019/12/05 Python
keras实现VGG16 CIFAR10数据集方式
2020/07/07 Python
如何使用python写截屏小工具
2020/09/29 Python
Goodee官方商店:迷你投影仪
2021/03/15 全球购物
六道php面试题附答案
2014/06/05 面试题
毕业生多媒体设计求职信
2013/10/12 职场文书
西式结婚主持词
2014/03/14 职场文书
单位消防安全责任书
2014/07/23 职场文书
小学生关于梦想的演讲稿
2014/08/22 职场文书
民主生活会对照检查材料(统计局)
2014/09/21 职场文书
万能检讨书
2015/01/27 职场文书
党员带头倡议书
2015/04/29 职场文书
Java设计模式之代理模式
2022/04/22 Java/Android