Django系列(1)-自动化生成API文档
PS: 个人深感python开发者社区氛围比安卓/ios/java差多了。不过，这也许是个机会～
前提: 本人开发环境是mac10.14.4，Python3.7.2
django-rest-swagger vs drf-yasg
百度google各种查询帖子，python中生成自动化API文档绝大部分用的都是django-rest-swagger库，然而此库作者表示在2019-06-04已停止更新，而且此库需要的第三方版本库是：
- Django 1.8+
- Django REST framework 3.5.1+
- Python 2.7, 3.5, 3.6
换句话说，django-rest-swagger并不支持Python3.7的环境，所以本人选择了drf-yasg库，它需要的第三方版本库是： - Django Rest Framework: 3.8, 3.9
- Django: 1.11, 2.1, 2.2
- Python: 2.7, 3.5, 3.6, 3.7
drf-yasg快速上手
安装
pip install -U drf-yasg
在settings.py声明app,并将debug设置为true
INSTALLED_APPS = [...'drf_yasg',...
]DEBUG = True
在根url.py添加scheme_view
from rest_framework import permissions
from drf_yasg.views import get_schema_view
from drf_yasg import openapischema_view = get_schema_view(openapi.Info(title="API文档",default_version='v1.0.0',contact=openapi.Contact(name='联系开发者', email="your email"),),permission_classes=(permissions.AllowAny,),
)urlpatterns = [... url('swagger', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
]
踩坑
1. 找不到drf目录下的静态文件
解决方案：测试环境settings.py中的DEBUG设置为true(方便生成api文档), 生产环境设置为False。在python环境中，如果使用drf库生成API文档，需要将DEBUG设置为true，否则找不到静态文件。
参考文档
https://github.com/axnsan12/drf-yasg
https://github.com/marcgibbons/django-rest-swagger
https://drf-yasg.readthedocs.io/en/stable/settings.html#validator-url
Django系列(1)-自动化生成API文档相关推荐
- wordpress rest api 登录_Python构建RESTful网络服务[Django篇：生成API文档]
链接:https://pan.baidu.com/s/15Mo9adr4Iw2W-um7WK68jA 提取码:ux79 系列文章介绍 本系列文章将详细介绍将Django官方引导教程中的投票项目改写为R ...
- 【接口文档】Django restful framework中自动生成API文档
Django restful framework中自动生成API文档 一.Swagger概述 1.引言 当接口开发完成,紧接着需要编写接口文档.传统的接口文档使用Word编写,or一些接口文档管理平台 ...
- 干掉 Swagger + Postman？测试接口直接生成API文档，这个国产文档工具真香！
点击上方"芋道源码",选择"设为星标" 管她前浪,还是后浪? 能浪的浪,才是好浪! 每天 10:33 更新文章,每天掉亿点点头发... 源码精品专栏 原创 | ...
- 干掉 Postman？测试接口直接生成 API 文档，这工具真香！
作者:小 G 来源:GitHubDaily " 阅读本文大概需要 5 分钟. " 前阵子,偶然发现一款国产 API 接口开发调试神器,上手尝鲜之后,真的有被惊艳到,功能齐全,对中文 ...
- 如何利用showdoc自动生成API文档
介绍 showdoc是一个适合IT团队的文档工具,阅读本文前需要对showdoc有基本了解 .基本介绍可看:https://www.showdoc.cc/help 对于写API文档这件事,虽然说文本编 ...
- 为TypeScript项目生成API文档
为TypeScript项目生成文档 使用typedoc为TypeScript项目生成API文档. 1. 使用typedoc生成HTML文档 需要安装 typedoc. npm i typedoc 可以 ...
- 干掉 Postman？测试接口直接生成API文档，这个文档工具真香！
欢迎关注方志朋的博客,回复"666"获面试宝典 实不相瞒我的收藏夹里躺着很多优质的开源项目,我有个爱好平时遇到感兴趣的开源项目都会记录下来,然后有时间在慢慢研究.前几天刚给同事分享 ...
- 干掉 Postman？测试接口直接生成API文档，这工具真香！
前几天粉丝群有小伙伴问,有啥好用的API文档工具推荐,无意间发现了一款工具,这里马不停蹄的来给大家分享一下. ShowDoc一个非常适合团队的在线API文档工具,也支持用docker自建文档服务,不过 ...
- 干掉 Postman？测试接口直接生成API文档，这个工具我爱了
前几天粉丝群有小伙伴问,有啥好用的API文档工具推荐,无意间发现了一款工具,这里马不停蹄的来给大家分享一下. ShowDoc一个非常适合团队的在线API文档工具,也支持用docker自建文档服务,不过 ...
最新文章
- 下一代零售技术：物联网、人工智能和5G将如何影响购物体验
- 在数据中心利用AI的5个理由
- .NET+IIS+MSSQL配置
- a java_java程序弹出a java exception has occurred
- Java操作Redis服务
- CentOS7中通过二进制文件与配置环境变量的方式安装Node
- 希尔伯特曲线的绘制c语言,用四叉树和希尔伯特曲线做空间索引
- php投票系统报告,投票系统设计
- CityEngine快捷键一览表
- mycat mysql 物理部署_一、MyCat的搭建
- 模板vs定制 门店小程序该如何选择？
- Docker(二) docker帮助、镜像及容器相关操作命令介绍
- 源码编译php mysql_linux下apache+mysql+php开发环境纯源代码编译搭建(转)
- 19.多个版本的Netcat概览
- 【ArcGIS|空间分析】焦点统计 （类型）
- 数据仓库详细介绍（九.数据质量）流程与工具
- Red Giant VFX Suite for mac(电影级视觉特效插件)
- 可区分英文字母：lL、iI、0Oo的系统字体
- 腾讯bugly热更新开发
- 2020CADCG会议专题报告深度学习和图像笔记