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显示天气预报
Mar 02 Python
Python装饰器使用示例及实际应用例子
Mar 06 Python
用Python实现斐波那契(Fibonacci)函数
Mar 25 Python
使用Python抓取豆瓣影评数据的方法
Oct 17 Python
Scrapy框架使用的基本知识
Oct 21 Python
如何使用python把ppt转换成pdf
Jun 29 Python
pycharm设置鼠标悬停查看方法设置
Jul 29 Python
django为Form生成的label标签添加class方式
May 20 Python
django ObjectDoesNotExist 和 DoesNotExist的用法
Jul 09 Python
Django nginx配置实现过程详解
Sep 10 Python
如何让PyQt5中QWebEngineView与JavaScript交互
Oct 21 Python
Python3.9.0 a1安装pygame出错解决全过程(小结)
Feb 02 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
fleaphp常用方法分页之Pager使用方法
2011/04/23 PHP
使用php记录用户通过搜索引擎进网站的关键词
2014/02/13 PHP
php数组编码转换示例详解
2014/03/11 PHP
php使用PDO方法详解
2014/12/27 PHP
ecshop 2.72如何修改后台访问地址
2015/03/03 PHP
Yii框架创建cronjob定时任务的方法分析
2017/05/23 PHP
IE6中链接A的href为javascript协议时不在当前页面跳转
2014/06/05 Javascript
使用FlexiGrid实现Extjs表格效果方法分享
2014/12/16 Javascript
JS脚本根据手机浏览器类型跳转WAP手机网站(两种方式)
2015/08/04 Javascript
JavaScript Array对象详解
2016/03/01 Javascript
JS判断浏览器是否安装flash插件的简单方法
2016/09/13 Javascript
jQuery实现立体式数字动态增加(animate方法)
2016/12/21 Javascript
canvas绘制的直线动画
2017/01/23 Javascript
Node.js通过身份证号验证年龄、出生日期与性别方法示例
2017/03/09 Javascript
JavaScript ES6中const、let与var的对比详解
2017/06/18 Javascript
微信小程序 蓝牙的实现实例代码
2017/06/27 Javascript
快速解决angularJS中用post方法时后台拿不到值的问题
2018/08/14 Javascript
详解vue如何使用rules对表单字段进行校验
2018/10/17 Javascript
详解微信小程序-canvas绘制文字实现自动换行
2019/04/26 Javascript
JS通过识别id、value值对checkbox设置选中状态
2020/02/19 Javascript
Python备份Mysql脚本
2008/08/11 Python
Python学习之asyncore模块用法实例教程
2014/09/29 Python
从Python程序中访问Java类的简单示例
2015/04/20 Python
浅谈Python中列表生成式和生成器的区别
2015/08/03 Python
python实现自动解数独小程序
2019/01/21 Python
Python opencv相机标定实现原理及步骤详解
2020/04/09 Python
python 制作python包,封装成可用模块教程
2020/07/13 Python
Bose加拿大官方网站:美国知名音响品牌
2019/03/21 全球购物
Lululemon加拿大官网:加拿大知名体育服装零售商
2019/04/12 全球购物
教师评优事迹材料
2014/01/10 职场文书
美丽乡村建设实施方案
2014/03/23 职场文书
文明礼貌演讲稿
2014/05/12 职场文书
综治工作心得体会
2014/09/11 职场文书
2014年学校法制宣传日活动总结
2014/11/01 职场文书
八年级数学教学反思
2016/02/17 职场文书
详解CSS不受控制的position fixed
2021/05/25 HTML / CSS