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 相关文章推荐
pygame学习笔记(3):运动速率、时间、事件、文字
Apr 15 Python
在Python中测试访问同一数据的竞争条件的方法
Apr 23 Python
django之常用命令详解
Jun 30 Python
Python中的pygal安装和绘制直方图代码分享
Dec 08 Python
Django使用httpresponse返回用户头像实例代码
Jan 26 Python
python提取图像的名字*.jpg到txt文本的方法
May 10 Python
python绘制热力图heatmap
Mar 23 Python
Pyqt QImage 与 np array 转换方法
Jun 27 Python
使用Python的Turtle库绘制森林的实例
Dec 18 Python
解决 jupyter notebook 回车换两行问题
Apr 15 Python
python实现图像高斯金字塔的示例代码
Dec 11 Python
在 Python 中使用 7zip 备份文件的操作
Dec 11 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
基于curl数据采集之单页面并行采集函数get_htmls的使用
2013/04/28 PHP
深入理解PHP JSON数组与对象
2016/07/19 PHP
PHP实现登陆并抓取微信列表中最新一组微信消息的方法
2017/07/10 PHP
PHP递归遍历文件夹去除注释并压缩php源代码的方法示例
2018/05/23 PHP
Laravel中10个有用的用法小结
2019/05/06 PHP
仅IE6/7/8中innerHTML返回值忽略英文空格的问题
2011/04/07 Javascript
浅谈Javascript面向对象编程
2011/11/15 Javascript
解析页面加载与js函数的执行 onload or ready
2013/12/12 Javascript
JQuery radio(单选按钮)操作方法汇总
2015/04/15 Javascript
jQuery插件bgStretcher.js实现全屏背景特效
2015/06/05 Javascript
AngularJs解决跨域问题案例详解(简单方法)
2016/05/19 Javascript
微信小程序 location API实例详解
2016/10/02 Javascript
jquery插件bootstrapValidator数据验证详解
2016/11/09 Javascript
荐书|您有一份JavaScript书单待签收
2017/07/21 Javascript
不得不知的ES6小技巧
2018/07/28 Javascript
JS构造一个html文本内容成文件流形式发送到后台
2018/07/31 Javascript
vuex根据不同的用户权限展示不同的路由列表功能
2019/09/20 Javascript
json字符串对象转换代码实例
2019/09/28 Javascript
vue动态渲染svg、添加点击事件的实现
2020/03/13 Javascript
[02:49]DOTA2完美大师赛首日观众采访
2017/11/23 DOTA
Python文件操作类操作实例详解
2014/07/11 Python
Python中使用pprint函数进行格式化输出的教程
2015/04/07 Python
Python中shutil模块的常用文件操作函数用法示例
2016/07/05 Python
使用python为mysql实现restful接口
2018/01/05 Python
Python的pygame安装教程详解
2020/02/10 Python
使用Pytorch搭建模型的步骤
2020/11/16 Python
最新的咖啡店创业计划书
2013/12/30 职场文书
冰淇淋店的创业计划书
2014/02/07 职场文书
优秀毕业生推荐信范文
2014/03/07 职场文书
网络编辑求职信
2014/04/30 职场文书
护理专业求职信
2014/06/15 职场文书
小学生勤俭节约演讲稿
2014/08/28 职场文书
居委会四风问题个人对照检查材料
2014/09/25 职场文书
会议欢迎词范文
2015/01/27 职场文书
仓库管理员岗位职责
2015/02/03 职场文书
营业员岗位职责
2015/02/11 职场文书