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实现下载文件的三种方法
Feb 09 Python
python操作excel的方法
Aug 16 Python
python中正则表达式 re.findall 用法
Oct 23 Python
Python面向对象类编写细节分析【类,方法,继承,超类,接口等】
Jan 05 Python
python批量修改文件夹及其子文件夹下的文件内容
Mar 15 Python
opencv导入头文件时报错#include的解决方法
Jul 31 Python
Django使用中间件解决前后端同源策略问题
Sep 02 Python
Django之使用内置函数和celery发邮件的方法示例
Sep 16 Python
Python对象的属性访问过程详解
Mar 05 Python
python中time.ctime()实例用法
Feb 03 Python
Python中的np.argmin()和np.argmax()函数用法
Jun 02 Python
使用python绘制横竖条形图
Apr 21 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
浅析ThinkPHP中的pathinfo模式和URL重写
2014/01/06 PHP
PHP中explode函数和split函数的区别小结
2016/08/24 PHP
懒就要懒到底——鼠标自动点击(含时间判断)
2007/02/20 Javascript
jQuery 使用手册(一)
2009/09/23 Javascript
jquery中ajax学习笔记一
2011/10/16 Javascript
dwz 如何去掉ajaxloading具体代码
2013/05/22 Javascript
根据选择不同的下拉值出现相对应的文本输入框
2013/08/01 Javascript
每天一篇javascript学习小结(属性定义方法)
2015/11/19 Javascript
JS实现点击登录弹出窗口同时背景色渐变动画效果
2016/03/25 Javascript
JS原型链怎么理解
2016/06/27 Javascript
D3.js实现饼状图的方法详解
2016/09/21 Javascript
jQuery实现点击后高亮背景固定显示的菜单效果【附demo源码下载】
2016/09/21 Javascript
JSON 必知必会 观后记
2016/10/27 Javascript
Web制作验证码功能实例代码
2017/06/19 Javascript
swiper移动端轮播插件(触碰图片之后停止轮播)
2017/12/28 Javascript
修改vue+webpack run build的路径方法
2018/09/01 Javascript
js 判断当前时间是否处于某个一个时间段内
2019/09/19 Javascript
JS实现扫码枪扫描二维码功能
2020/01/03 Javascript
python虚拟环境 virtualenv的简单使用
2020/01/21 Javascript
[01:18:35]DOTA2-DPC中国联赛 正赛 Elephant vs LBZS BO3 第一场 1月29日
2021/03/11 DOTA
Python调用C语言开发的共享库方法实例
2015/03/18 Python
OpenCV+Python识别车牌和字符分割的实现
2019/01/31 Python
如何使用Python发送HTML格式的邮件
2020/02/11 Python
在pycharm中为项目导入anacodna环境的操作方法
2020/02/12 Python
python实现飞船大战
2020/04/24 Python
CSS3等相关属性制作分页导航实现代码
2012/12/24 HTML / CSS
如何执行一个shell程序
2012/11/23 面试题
新学期红领巾广播稿
2014/01/14 职场文书
公司合作意向书范文
2014/07/30 职场文书
文艺晚会开场白
2015/05/29 职场文书
停发工资证明范本
2015/06/12 职场文书
2016幼儿园新学期寄语
2015/12/03 职场文书
2016学习全国教书育人楷模先进事迹心得体会
2016/01/21 职场文书
经典格言警句:没有热忱,世间便无进步
2019/11/13 职场文书
Python爬虫基础初探selenium
2021/05/31 Python
Vue-Element-Admin集成自己的接口实现登录跳转
2021/06/23 Vue.js