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执行外部程序的常用方法小结
Mar 21 Python
Python利用带权重随机数解决抽奖和游戏爆装备问题
Jun 16 Python
Python编程实现微信企业号文本消息推送功能示例
Aug 21 Python
python3爬取淘宝信息代码分析
Feb 10 Python
将python代码和注释分离的方法
Apr 21 Python
python 搭建简单的http server,可直接post文件的实例
Jan 03 Python
浅谈pandas筛选出表中满足另一个表所有条件的数据方法
Feb 08 Python
详解PyCharm安装MicroPython插件的教程
Jun 24 Python
Python程序打包工具py2exe和PyInstaller详解
Jun 28 Python
python实现ip地址查询经纬度定位详解
Aug 30 Python
Python读取xlsx数据生成图标代码实例
Aug 12 Python
python爬虫之selenium库的安装及使用教程
May 23 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
关于mysql 字段的那个点为是定界符
2007/01/15 PHP
学习使用curl采集curl使用方法
2012/01/11 PHP
PHP中Http协议post请求参数
2015/11/02 PHP
js GridView 实现自动计算操作代码
2009/03/25 Javascript
javascript cookies操作集合
2010/04/12 Javascript
关于锚点跳转及jQuery下相关操作与插件
2012/10/01 Javascript
javascript 三种方法实现获得和设置以及移除元素属性
2013/03/20 Javascript
html中使用javascript调用本地程序(exe、doc等)实现代码
2013/04/26 Javascript
超炫的jquery仿flash导航栏特效
2014/11/11 Javascript
实例浅析js的this
2016/12/11 Javascript
Angular2.js实现表单验证详解
2017/06/23 Javascript
iscroll动态加载数据完美解决方法
2017/07/18 Javascript
浅析vue中常见循环遍历指令的使用 v-for
2018/04/18 Javascript
vue 弹窗时 监听手机返回键关闭弹窗功能(页面不跳转)
2019/05/10 Javascript
Vue+ElementUI table实现表格分页
2019/12/14 Javascript
微信小程序实现上拉加载功能示例【加载更多数据/触底加载/点击加载更多数据】
2020/05/29 Javascript
跟老齐学Python之一个免费的实验室
2014/09/14 Python
Python中使用copy模块实现列表(list)拷贝
2015/04/14 Python
Python使用pygame模块编写俄罗斯方块游戏的代码实例
2015/12/08 Python
Django 生成登陆验证码代码分享
2017/12/12 Python
Python统计单词出现的次数
2018/04/04 Python
Python pymongo模块常用操作分析
2018/09/01 Python
python找出列表中大于某个阈值的数据段示例
2019/11/24 Python
利用python中集合的唯一性实现去重
2020/02/11 Python
解决Opencv+Python cv2.imshow闪退问题
2020/04/24 Python
Python reduce函数作用及实例解析
2020/05/08 Python
俄罗斯名牌服装网上商店:UNIQUE FABRIC
2019/07/25 全球购物
董事长秘书岗位职责
2013/11/29 职场文书
大学四年的个人自我评价
2014/01/14 职场文书
银行批评与自我批评
2014/02/10 职场文书
政治思想表现评语
2014/05/04 职场文书
李敖北大演讲稿
2014/05/24 职场文书
员工安全责任书范本
2014/07/24 职场文书
公司出纳岗位职责
2015/03/31 职场文书
pytorch显存一直变大的解决方案
2021/04/08 Python
Logback 使用TurboFilter实现日志级别等内容的动态修改操作
2021/08/30 Java/Android