- 综合排序
- 最热优先
- 最新优先
- 来自专栏HelloGitHub
第 16 篇：别再手动管理接口文档了
install drf-yasg 然后将 drf-yasg 添加到 INSTALLED_APPS 配置项中： # filename="blogproject/settings/common.py" 其中 toc 和 body_html 因为不是 Post 中定义的字段，所以 drf-yasg 无法知道关于这两个字段的说明。 drf-yasg 是如何知道这个接口会返回哪些响应参数的呢？ drf-yasg 推断的响应类型是正确的，但内容不对。 参考资料 以下是教程中用到的一些参考： OpenAPI Specification[6] drf-yasg 源码仓库[7] drf-yasg 官方文档[8] 小贴士： drf-yasg 的官方文档对于这个库的使用方法写的不是很清晰 / [7] drf-yasg 源码仓库: https://github.com/axnsan12/drf-yasg [8] drf-yasg 官方文档: https://drf-yasg.readthedocs.io
2.3K20发布于 2021-05-14 - 来自专栏山山仙人的专栏
drf的接口文档生成与管理
Swagger生成接口文档 3.1 Swagger介绍 3.2 安装django-rest-swagger库 3.3 配置app及swagger 3.4 配置相关路由 3.5 访问查看 3.6 说明 4、drf-yasg (Swagger升级版) 4.1 drf-yasg介绍 4.2 安装drf-yasg库 4.3 配置app 4.4 配置路由url 4.5 访问查看 4.6 更多配置及说明 4.6.1 get_schema_view 上面列出的工具或多或少都需要花费一定时间去手动维护，在drf后端项目中可以利用其自带的Core API、第三方库Swagger以及更好的drf-yasg自动生成接口文档 2、Core API生成接口文档 3.6 说明 Django REST Swagger从19年开始就已弃用不再维护了，作者在官方网站上说明了更推荐使用drf-yasg 可以阅读https://github.com/marcgibbons /django-rest-swagger查看更多相关说明 4、drf-yasg(Swagger升级版) 4.1 drf-yasg介绍 参考drf-yasg官网，drf-yasg是基于Swagger和OpenAPI
5.6K10发布于 2021-04-13 - 来自专栏Django从入门到实战
Django集成Swagger全指南：两种实现方案详解
更多数据类型支持和更好的扩展性通过集成 Swagger，开发者可以获得：自动生成的交互式 API 文档在线接口调试功能标准化的 API 描述格式（JSON/YAML）便于前后端协作和 API 版本管理两种方案对比特性 drf-yasg 高 学习曲线 平缓 稍陡 推荐场景 简单项目快速集成复杂项目、需要高级定制二、方案一：使用 drf-yasg （支持 Swagger 2.0）工具介绍drf-yasg 是基于 Django REST Framework (DRF) 的 API 文档生成工具，专注于 Swagger 2.0 规范，具有以下特点：动态生成 Swagger UI，支持多种主题可自定义文档样式和内容支持隐藏指定字段、添加额外参数等高级功能安装步骤安装pip install -U drf-yasg配置settings.py：在 INSTALLED_APPS
40510编辑于 2025-07-22 - 来自专栏测试游记
3.寻光集后台管理系统-依赖环境准备
比如进行模糊查询 drf-yasg https://drf-yasg.readthedocs.io/en/stable/ drf-yasg根据代码生成swagger页面，方便后面的调试 Faker https django-filter==21.1 djangorestframework==3.13.1 djangorestframework-simplejwt==5.1.0 PyMySQL==1.0.2 drf-yasg
71750编辑于 2022-12-02 - 来自专栏布鲁斯鱼的妙想天开
让 DRF Views 支持依赖注入
同时我们需要满足几个条件： 能够兼容当前的 ViewSet 类 能够复用 Serializer （可选）能够复用 drf-yasg 综上，我写了一个 简单的文件 ，你可以将它 Copy 到你的 DRF 项目中就可以改造原来的 ViewSet （当前需求是比较简单的，封装成 SDK 然后安装依赖的成本反而高于直接复制粘贴，这样大家可以一起偷懒） 最后的效果： 原来的 ViewSet （包含 drf-yasg return results （可以通过 gist 评论 获取更多的例子） 这样的改造我们得到了一些好处： 仅需要简单改造原来的 ViewSet 完全继承原来的 Serializer 完整支持 drf-yasg
61650编辑于 2022-11-02 - 来自专栏测试开发技术
Python3+ Django3：自动生成Swagger接口文档
Swagger方法时，都是基于django-rest-swagger库进行讲解的，都殊不知，从2019年6月份开始，官方已经废弃了该库，在django 3.0中已经不支持该库了，取而代之的是全新的第三方drf-yasg GitHub地址： https://github.com/marcgibbons/django-rest-swagger 所以本文也是基于drf-yasg库来实现在Django3中接入Swagger框架的 1、安装drf-yasg库 pip install -U drf-yasg GitHub项目地址： https://github.com/axnsan12/drf-yasg 2、修改项目settings.py )), path('api-auth/', include('rest_framework.urls', namespace='rest_framework')), # 配置drf-yasg
17.3K32发布于 2020-01-17 - 来自专栏python爬虫实战之路
Django Swagger文档库drf-spectacular
因此我选择使用Swagger文档，之前使用过drf-yasg，但是drf-yasg现在还不支持OpenAPI 3.0，而在drf-yasg的官方文档中为我们推荐了另一个库：drf-spectacular ，而且声明了drf-yasg不太可能支持OpenAPI 3.0，因此推荐我们使用drf-spectacular这个库。
2.6K20编辑于 2023-03-20 - 来自专栏测试游记
测试开发进阶(三十)
使用drf-yasg 支持swagger $ pip install drf-yasg 添加到 INSTALLED_APPS中 INSTALLED_APPS = [ ...
95540发布于 2019-10-30 - 来自专栏技术汇总专栏
全面掌握Django开发RESTful API：从基础到高级的实战指南
使用drf-yasg生成Swagger文档drf-yasg是一个用于生成Swagger文档的第三方库，它能够自动生成交互式API文档。 首先安装drf-yasg：$ pip install drf-yasg在项目的urls.py中添加Swagger文档的路由：# myproject/urls.pyfrom rest_framework
1.2K20编辑于 2024-11-15 - 来自专栏HelloGitHub
《HelloGitHub》第 71 期
包括搜索、排序、数据结构、机器学习、密码、神经网络等方面 地址：https://github.com/TheAlgorithms/Python 27、drf-yasg：为 Django Rest Framework 接口自动生成 Swagger 接口文档的库 地址：https://github.com/axnsan12/drf-yasg 28、tstock：在命令行看股票走势的工具 地址：https://github.com
2.4K00编辑于 2022-04-07
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号