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实现带声音的摩斯码翻译实现方法
May 20 Python
python实现简单名片管理系统
Nov 30 Python
Python多线程原理与用法实例剖析
Jan 22 Python
使用pyecharts生成Echarts网页的实例
Aug 12 Python
使用python远程操作linux过程解析
Dec 04 Python
np.random.seed() 的使用详解
Jan 14 Python
Selenium 滚动页面至元素可见的方法
Mar 18 Python
解决matplotlib.pyplot在Jupyter notebook中不显示图像问题
Apr 22 Python
Python键鼠操作自动化库PyAutoGUI简介(小结)
May 17 Python
Python中的全局变量如何理解
Jun 04 Python
Python基础之函数嵌套知识总结
May 23 Python
python 实现图片特效处理
Apr 03 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
AJAX的跨域访问-两种有效的解决方法介绍
2013/06/22 PHP
Smarty实现页面静态化(生成HTML)的方法
2016/05/23 PHP
全面解析PHP操作Memcache基本函数
2016/07/14 PHP
简单的自定义php模板引擎
2016/08/26 PHP
PHP空值检测函数与方法汇总
2017/11/19 PHP
Laravel5框架添加自定义辅助函数的方法
2018/08/01 PHP
PHP 判断字符串是中文还是英文, 或者是中英混合
2021/03/09 PHP
JS获取scrollHeight问题想到的标准问题
2007/05/27 Javascript
Ajax,UTF-8还是GB2312 eval 还是execScript
2008/11/13 Javascript
jQuery中与toggleClass等价的程序段 以及未来学习的方向
2010/03/18 Javascript
使用js完成节点的增删改复制等的操作
2014/01/02 Javascript
javaScript使用EL表达式的几种方式
2014/05/27 Javascript
jquery实现在页面加载完毕后获取图片高度或宽度
2014/06/16 Javascript
EasyUI 中combotree 默认不能选择父节点的实现方法
2016/11/07 Javascript
JavaScript中关于for循环删除数组元素内容时出现的问题
2016/11/21 Javascript
web打印小结
2017/01/11 Javascript
js实现数组去重方法及效率?Ρ? target=
2017/02/14 Javascript
微信小程序  http请求封装详解及实例代码
2017/02/15 Javascript
微信小程序页面跳转功能之从列表的item项跳转到下一个页面的方法
2017/11/27 Javascript
Vue.directive使用注意(小结)
2018/08/31 Javascript
angularjs使用div模拟textarea文本框的方法
2018/10/02 Javascript
angular 用Observable实现异步调用的方法
2018/12/27 Javascript
快速了解Node中的Stream流是什么
2019/02/13 Javascript
node微信开发之获取access_token+自定义菜单
2019/03/17 Javascript
详解JSON.stringify()的5个秘密特性
2020/05/26 Javascript
Python提取Linux内核源代码的目录结构实现方法
2016/06/24 Python
Python删除Java源文件中全部注释的实现方法
2017/08/30 Python
django中的setting最佳配置小结
2017/11/21 Python
虚拟机下载python是否需要联网
2020/07/27 Python
使用CSS3来实现滚动视差效果的教程
2015/08/24 HTML / CSS
美国时尚在线:Showpo
2017/09/08 全球购物
在Java开发中如何选择使用哪种集合类
2016/08/09 面试题
幼儿园英语教学反思
2014/01/30 职场文书
2014年社区学雷锋活动总结
2014/03/09 职场文书
2015年街道除四害工作总结
2015/05/15 职场文书
雷锋之歌观后感
2015/06/10 职场文书