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程序设计入门(1)基本语法简介
Jun 13 Python
初步探究Python程序的执行原理
Apr 11 Python
python过滤字符串中不属于指定集合中字符的类实例
Jun 30 Python
用python做一个搜索引擎(Pylucene)的实例代码
Jul 05 Python
浅谈Django自定义模板标签template_tags的用处
Dec 20 Python
Python解析并读取PDF文件内容的方法
May 08 Python
大家都说好用的Python命令行库click的使用
Nov 07 Python
妙用itchat! python实现久坐提醒功能
Nov 25 Python
Python pandas库中的isnull()详解
Dec 26 Python
使用Python实现Wake On Lan远程开机功能
Jan 22 Python
python线程join方法原理解析
Feb 11 Python
python实现剪贴板的操作
Jul 01 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文件夹与文件目录操作函数介绍
2013/09/09 PHP
yii上传文件或图片实例
2014/04/01 PHP
PHP异常Parse error: syntax error, unexpected T_VAR错误解决方法
2014/05/06 PHP
wamp安装后自定义配置的方法
2014/08/23 PHP
PHP实现的简单mock json脚本分享
2015/02/10 PHP
PHP实现的简单适配器模式示例
2017/06/22 PHP
php 利用socket发送GET,POST请求的实例代码
2020/07/04 PHP
jquery应该如何来设置改变按钮input的onclick事件
2012/12/10 Javascript
js下拉框二级关联菜单效果代码具体实现
2013/08/03 Javascript
jquery 插件实现瀑布流图片展示实例
2015/04/03 Javascript
jQuery实现批量判断表单中文本框非空的方法(2种方法)
2015/12/09 Javascript
深入理解jQuery中的事件冒泡
2016/05/24 Javascript
第一次接触神奇的Bootstrap基础排版
2016/07/26 Javascript
jQuery post数据至ashx实例详解
2016/11/18 Javascript
Javascript DOM事件操作小结(监听鼠标点击、释放,悬停、离开等)
2017/01/20 Javascript
AngularJS页面带参跳转及参数解析操作示例
2017/06/28 Javascript
vuejs实现ready函数加载完之后执行某个函数的方法
2018/08/31 Javascript
详解小程序毫秒级倒计时(适用于拼团秒杀功能)
2019/05/05 Javascript
vue+element搭建后台小总结 el-dropdown下拉功能
2020/04/10 Javascript
vue-cli脚手架的.babelrc文件用法说明
2020/09/11 Javascript
[10:21]2018DOTA2国际邀请赛寻真——Winstrike
2018/08/11 DOTA
Python中使用Flask、MongoDB搭建简易图片服务器
2015/02/04 Python
在Python中使用matplotlib模块绘制数据图的示例
2015/05/04 Python
解析Python中的二进制位运算符
2015/05/13 Python
浅谈Python中重载isinstance继承关系的问题
2018/05/04 Python
在Python中给Nan值更改为0的方法
2018/10/30 Python
python树的同构学习笔记
2019/09/14 Python
Python交互环境下打印和输入函数的实例内容
2020/02/16 Python
借助Paramiko通过Python实现linux远程登陆及sftp的操作
2020/03/16 Python
python按照list中字典的某key去重的示例代码
2020/10/13 Python
html5理解head_动力节点Java学院整理
2017/07/13 HTML / CSS
精彩的大学生自我评价
2013/11/17 职场文书
会计求职信
2014/05/29 职场文书
大学生个人求职信
2014/06/02 职场文书
开业庆典活动策划方案
2014/09/21 职场文书
如何基于python实现单目三维重建详解
2022/06/25 Python