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之import机制详解
Jul 03 Python
Python中http请求方法库汇总
Jan 06 Python
python3实现抓取网页资源的 N 种方法
May 02 Python
Django项目中添加ldap登陆认证功能的实现
Apr 04 Python
ubuntu 18.04搭建python环境(pycharm+anaconda)
Jun 14 Python
python实现代码统计器
Sep 19 Python
Python字典的概念及常见应用实例详解
Oct 30 Python
Python pandas RFM模型应用实例详解
Nov 20 Python
python 消除 futureWarning问题的解决
Dec 25 Python
Pytorch: 自定义网络层实例
Jan 07 Python
基于python3抓取pinpoint应用信息入库
Jan 08 Python
python matplotlib imshow热图坐标替换/映射实例
Mar 14 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/07/19 PHP
PHP CURL采集百度搜寻结果图片不显示问题的解决方法
2017/02/03 PHP
php操作access数据库的方法详解
2017/02/22 PHP
Laravel中正确地返回HTTP状态码方法示例
2019/09/10 PHP
js中查找最近的共有祖先元素的实现代码
2010/12/30 Javascript
js实现翻页后保持checkbox选中状态的实现方法
2012/11/03 Javascript
AngularJS模块管理问题的非常规处理方法
2015/04/29 Javascript
jQuery遍历节点树方法分析
2016/09/08 Javascript
javascript入门之string对象【新手必看】
2016/11/22 Javascript
详解angular中如何监控dom渲染完毕
2017/01/03 Javascript
JS小数转换为整数的方法分析
2017/01/07 Javascript
基于jQuery实现弹幕APP
2017/02/10 Javascript
vue省市区三联动下拉选择组件的实现
2017/04/28 Javascript
js实现移动端编辑添加地址【模仿京东】
2017/04/28 Javascript
nodeJS实现简单网页爬虫功能的实例(分享)
2017/06/08 NodeJs
js学习总结_选项卡封装(实例讲解)
2017/07/13 Javascript
Vuex实现计数器以及列表展示效果
2018/03/10 Javascript
pm2启动ssr失败的解决方法
2019/06/29 Javascript
layUI实现三级导航菜单效果
2019/07/26 Javascript
JS 遍历 json 和 JQuery 遍历json操作完整示例
2019/11/11 jQuery
[04:44]DOTA2英雄梦之声_第12期_矮人直升机
2014/06/21 DOTA
[02:09:59]火猫TV国士无双dota2 6.82版本详解(下)
2014/09/29 DOTA
利用python写个下载teahour音频的小脚本
2017/05/08 Python
Python操作MongoDB详解及实例
2017/05/18 Python
python控制windows剪贴板,向剪贴板中写入图片的实例
2018/05/31 Python
基于python 取余问题(%)详解
2020/06/03 Python
html5指南-7.geolocation结合google maps开发一个小的应用
2013/01/07 HTML / CSS
Pamela Love官网:纽约设计师Pamela Love的精美、时尚和穿孔珠宝
2020/10/19 全球购物
汽车运用工程系毕业生自荐信
2013/12/27 职场文书
《走一步再走一步》教学反思
2014/02/15 职场文书
结对共建工作方案
2014/06/02 职场文书
学校周年庆活动方案
2014/08/22 职场文书
机关领导干部作风整顿整改措施
2014/09/19 职场文书
小学语文教师年度考核个人总结
2015/02/05 职场文书
重阳节活动主持词
2015/07/04 职场文书
SQL实现LeetCode(178.分数排行)
2021/08/04 MySQL