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系列之新版本导入httplib模块报ImportError解决方案
May 23 Python
用python登录Dr.com思路以及代码分享
Jun 25 Python
用python删除java文件头上版权信息的方法
Jul 31 Python
Python爬虫抓取手机APP的传输数据
Jan 22 Python
Python的消息队列包SnakeMQ使用初探
Jun 29 Python
Python中格式化format()方法详解
Apr 01 Python
Python同步遍历多个列表的示例
Feb 19 Python
Django REST框架创建一个简单的Api实例讲解
Nov 05 Python
python3实现网页版raspberry pi(树莓派)小车控制
Feb 12 Python
python 合并多个excel中同名的sheet
Jan 22 Python
Elasticsearch 聚合查询和排序
Apr 19 Python
python区块链持久化和命令行接口实现简版
May 25 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 array的学习笔记
2012/05/10 PHP
PHP Class&Object -- 解析PHP实现二叉树
2013/06/25 PHP
PHP编写daemon process详解及实例代码
2016/09/30 PHP
php实现微信支付之企业付款
2018/05/30 PHP
JavaScript可否多线程? 深入理解JavaScript定时机制
2012/05/23 Javascript
javascript数据结构之双链表插入排序实例详解
2015/11/25 Javascript
jQuery实现的超简单点赞效果实例分析
2015/12/31 Javascript
Webwork 实现文件上传下载代码详解
2016/02/02 Javascript
基于BootStrap Metronic开发框架经验小结【六】对话框及提示框的处理和优化
2016/05/12 Javascript
JS本地刷新返回上一页代码
2016/07/25 Javascript
深入理解JavaScript函数参数(推荐)
2016/07/26 Javascript
AngularJS表格详解及示例代码
2016/08/17 Javascript
vue.js动态数据绑定学习笔记
2017/05/19 Javascript
js 实现复选框只能选择一项的示例代码
2018/01/23 Javascript
微信小程序实现文字跑马灯效果
2020/05/26 Javascript
JavaScript创建对象的四种常用模式实例分析
2019/01/11 Javascript
JS实现判断有效的数独算法示例
2019/02/25 Javascript
了解前端理论:rscss和rsjs
2019/05/23 Javascript
JS如何实现动态添加的元素绑定事件
2019/11/12 Javascript
node.js 微信开发之定时获取access_token
2020/02/07 Javascript
Python利用递归和walk()遍历目录文件的方法示例
2017/07/14 Python
python 处理string到hex脚本的方法
2018/10/26 Python
Python 实现的 Google 批量翻译功能
2019/08/26 Python
PyCharm 在Windows的有用快捷键详解
2020/04/07 Python
python中二分查找法的实现方法
2020/12/06 Python
HTML5 weui使用笔记
2019/11/21 HTML / CSS
世界上最大的家庭自动化公司:Smarthome
2017/12/20 全球购物
初中物理教学反思
2014/01/14 职场文书
产品包装策划方案
2014/05/18 职场文书
共产党员岗位承诺书
2014/05/29 职场文书
高中毕业典礼演讲稿
2014/09/09 职场文书
2015大学生实训报告
2014/11/05 职场文书
初中学生操行评语
2014/12/26 职场文书
2015迎新晚会开场白
2015/05/29 职场文书
社区结对共建协议书
2016/03/23 职场文书
Nginx四层负载均衡的配置指南
2021/06/11 Servers