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 相关文章推荐
详解C++编程中一元运算符的重载
Jan 19 Python
Python简单生成随机姓名的方法示例
Dec 27 Python
python微信跳一跳系列之色块轮廓定位棋盘
Feb 26 Python
pip安装时ReadTimeoutError的解决方法
Jun 12 Python
python实现图片中文字分割效果
Jul 22 Python
Python 在OpenCV里实现仿射变换—坐标变换效果
Aug 30 Python
Python 3.6 中使用pdfminer解析pdf文件的实现
Sep 25 Python
Flask框架请求钩子与request请求对象用法实例分析
Nov 07 Python
简单了解Python读取大文件代码实例
Dec 18 Python
python不使用for计算两组、多个矩形两两间的iou方式
Jan 18 Python
tensorflow 实现自定义梯度反向传播代码
Feb 10 Python
使用keras内置的模型进行图片预测实例
Jun 17 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
discuz7 phpMysql操作类
2009/06/21 PHP
php获取文件类型和文件信息的方法
2015/07/10 PHP
全面解析PHP面向对象的三大特征
2017/06/10 PHP
ext读取两种结构的xml的代码
2008/11/05 Javascript
把文本中的URL地址转换为可点击链接的JavaScript、PHP自定义函数
2014/07/29 Javascript
JS往数组中添加项性能分析
2015/02/25 Javascript
jQuery动画效果实现图片无缝连续滚动
2016/01/12 Javascript
Node.js 条形码识别程序构建思路详解
2016/02/14 Javascript
微信公众号 客服接口的开发实例详解
2016/09/28 Javascript
关于Vue.js一些问题和思考学习笔记(2)
2016/12/02 Javascript
微信小程序中显示html格式内容的方法
2017/04/25 Javascript
jQuery DOM节点的遍历方法小结
2017/08/15 jQuery
JavaScript设计模式之模板方法模式原理与用法示例
2018/08/07 Javascript
VUE2.0+ElementUI2.0表格el-table实现表头扩展el-tooltip
2018/11/30 Javascript
vue多次循环操作示例
2019/02/08 Javascript
vue2.0 实现富文本编辑器功能
2019/05/26 Javascript
[53:10]2018DOTA2亚洲邀请赛 4.6 淘汰赛 VP vs VG 第一场
2018/04/11 DOTA
Python爬取读者并制作成PDF
2015/03/10 Python
Python正则抓取网易新闻的方法示例
2017/04/21 Python
python脚本生成caffe train_list.txt的方法
2018/04/27 Python
Python一句代码实现找出所有水仙花数的方法
2018/11/13 Python
Django 配置多站点多域名的实现步骤
2019/05/17 Python
pytorch中获取模型input/output shape实例
2019/12/30 Python
使用Tkinter制作信息提示框
2020/02/18 Python
django实现模板中的字符串文字和自动转义
2020/03/31 Python
python利用 keyboard 库记录键盘事件
2020/10/16 Python
python海龟绘图之画国旗实例代码
2020/11/11 Python
详解python第三方库的安装、PyInstaller库、random库
2021/03/03 Python
推荐一些比较有用的css3新属性
2014/11/11 HTML / CSS
兰蔻英国官网:Lancome英国
2019/04/30 全球购物
德国最大的服装、鞋子和配件在线商店之一:Outfits24
2019/07/23 全球购物
意大利奢侈品牌在线精品店:Jole.it
2020/11/23 全球购物
介绍一下linux的文件权限
2012/02/15 面试题
自动化专业个人求职信范文
2013/11/29 职场文书
优秀团员主要事迹材料
2015/11/05 职场文书
Win10鼠标轨迹怎么开 Win10显示鼠标轨迹方法
2022/04/06 数码科技