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 相关文章推荐
pydev使用wxpython找不到路径的解决方法
Feb 10 Python
python33 urllib2使用方法细节讲解
Dec 03 Python
python logging日志模块以及多进程日志详解
Apr 18 Python
Django中反向生成models.py的实例讲解
May 30 Python
Python面向对象之接口、抽象类与多态详解
Aug 27 Python
Python学习笔记之Break和Continue用法分析
Aug 14 Python
Python操作SQLite/MySQL/LMDB数据库的方法
Nov 07 Python
Python关于反射的实例代码分享
Feb 20 Python
python实现可下载音乐的音乐播放器
Feb 25 Python
Jupyter Notebook折叠输出的内容实例
Apr 22 Python
Django使用Profile扩展User模块方式
May 14 Python
Python命名空间及作用域原理实例解析
Aug 12 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
世界咖啡生产者论坛呼吁:需要立即就咖啡价格采取认真行动
2021/03/06 咖啡文化
PHP新手上路(十)
2006/10/09 PHP
php猜单词游戏
2015/09/29 PHP
老生常谈php 正则中的i,m,s,x,e分别表示什么
2017/03/02 PHP
php7 参数、整形及字符串处理机制修改实例分析
2020/05/25 PHP
jQuery 性能优化手册 推荐
2010/02/23 Javascript
最佳的addEvent事件绑定是怎样诞生的
2011/10/24 Javascript
jquery怎样实现ajax联动框(二)
2013/03/08 Javascript
JQuery对id中含有特殊字符的转义处理示例
2013/09/06 Javascript
用jQuery模拟select下拉框的简单示例代码
2014/01/26 Javascript
angularJS结合canvas画图例子
2015/02/09 Javascript
简介可以自动完成UI的AngularJS工具angular-smarty
2015/06/23 Javascript
nodejs+websocket实时聊天系统改进版
2017/05/18 NodeJs
node+vue实现用户注册和头像上传的实例代码
2017/07/20 Javascript
vue2.0s中eventBus实现兄弟组件通信的示例代码
2017/10/25 Javascript
Angular项目从新建、打包到nginx部署全过程记录
2017/12/09 Javascript
JavaScript时间戳与时间日期间相互转换
2017/12/11 Javascript
微信小程序实现给嵌套template模板传递数据的方式总结
2017/12/18 Javascript
完美解决通过IP地址访问VUE项目的问题
2020/07/18 Javascript
jQuery实现移动端扭蛋机抽奖
2020/11/08 jQuery
Antd-vue Table组件添加Click事件,实现点击某行数据教程
2020/11/17 Javascript
vue 实现基础组件的自动化全局注册
2020/12/25 Vue.js
详解Python命令行解析工具Argparse
2016/04/20 Python
用Django实现一个可运行的区块链应用
2018/03/08 Python
Python paramiko模块的使用示例
2018/04/11 Python
Pandas 数据框增、删、改、查、去重、抽样基本操作方法
2018/04/12 Python
python爬虫项目设置一个中断重连的程序的实现
2019/07/26 Python
python3获取当前目录的实现方法
2019/07/29 Python
Tensorflow中的降维函数tf.reduce_*使用总结
2020/04/20 Python
Python Selenium模块安装使用教程详解
2020/07/09 Python
python线程优先级队列知识点总结
2021/02/28 Python
美国最佳在线航班预订网站:LookupFare
2019/03/26 全球购物
Timberland德国官网:靴子、鞋子、衣服、夹克及配件
2019/12/10 全球购物
销售员自我评价怎么写
2013/09/19 职场文书
餐厅保洁员岗位职责
2015/04/10 职场文书
攻略丨滑雪究竟该选哪款对讲机?
2022/02/18 无线电