讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在Python Django中集成Swagger接口文档_使用drf-yasg插件生成UI

风伟吖_7694

风伟吖_7694

发布时间:2026-05-20 09:12:23

|

214人浏览过

|

来源于php中文网

原创

必须配置DEFAULT_SCHEMA_CLASS,否则drf-yasg无法识别接口,导致Swagger UI显示“No operations defined”;需在settings.py中设置为'drf_yasg.inspectors.SwaggerAutoSchema',并正确注册app和挂载路由。

如何在python django中集成swagger接口文档_使用drf-yasg插件生成ui

drf-yasg 安装与基础配置为什么必须加 DEFAULT_SCHEMA_CLASS

不加这个配置,Django REST Framework 会默认用 coreapi 生成 schema,而 drf-yasg 的 UI 完全依赖它自己的 SwaggerAutoSchema。结果就是页面能打开,但所有接口都显示 “No operations defined”,点进去空空如也。

正确做法是确保 settings.py 中有:

REST_FRAMEWORK = {
    'DEFAULT_SCHEMA_CLASS': 'drf_yasg.inspectors.SwaggerAutoSchema',
}

同时确认已安装并注册了 app:

  • pip install drf-yasg
  • INSTALLED_APPS 里加上 'drf_yasg'

URL 路由怎么写才让 Swagger UI 正常加载

常见错误是直接把 get_schema_view 当成普通视图函数塞进 urlpatterns,漏掉参数或调用方式不对,导致 404 或 JSON 解析失败。

立即学习“Python免费学习笔记(深入)”;

必须用 get_schema_view 返回的可调用对象,并显式传入 urlconf(尤其在多 URL 配置或子应用路由时):

from drf_yasg.views import get_schema_view
from drf_yasg import openapi
<p>schema_view = get_schema_view(
openapi.Info(
title="API",
default_version='v1',
),
public=True,
urlconf='myproject.urls',  # ⚠️ 这个不能少,否则找不到视图
)

然后在主 urls.py 中这样挂载:

Django Wrap
Django Wrap

强戈环形山: q15040409-刻画家功能概述强戈环形山: q15040409-刻画家是一项面向实际任务的技能,主要用于平顶山: 维西翁: 1:1.0. 塔格斯: rap.github: 自动化。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。核心要点使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。从功能定位来看,该

下载
  • path('swagger/', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui')
  • path('redoc/', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc')

ViewSet 和 APIView 的 docstring 怎么写才能被正确解析

drf-yasg 默认只读取类 docstring,且要求格式严格:第一行是简短描述,空一行后是详细说明(支持简单 reStructuredText),再空一行才是参数、返回值等字段注释。

容易踩的坑:

  • 用 # 写注释 → 不识别,必须用 """ 包裹的 docstring
  • 没空行分隔 → 整段被当标题,参数字段(如 :param:)被忽略
  • 字段名拼错,比如写成 :param str user_id: → 应为 :param user_id:,类型写在冒号后空格后::type user_id: int

示例有效写法:

class UserListView(APIView):
    """获取用户列表
<pre class='brush:python;toolbar:false;'>支持分页和关键词搜索。

:param search: 用户名模糊匹配
:type search: str
:param page: 页码
:type page: int
"""
def get(self, request):
    ...

为什么生产环境访问 Swagger 页面报 500 或提示 ImportError: cannot import name 'force_text'

这是 drf-yasg 旧版本(django.utils.encoding.force_text,新版本 Django 改成了 force_str。

解决方法只有两个:

  • 升级到 drf-yasg >= 1.20.0(推荐):pip install --upgrade drf-yasg
  • 降级 Django 到 3.2.x(不推荐,安全与维护风险高)

升级后如果仍报错,检查是否残留本地修改或缓存:清空 __pycache__、重启服务、确认 pip show drf-yasg 输出的版本号准确。

另外,别在生产环境暴露 /swagger/ 路径——即使加了权限控制,UI 本身会把所有接口定义吐给前端,敏感字段(如 password)若没在 serializer 中显式设为 write_only=True,就可能被文档直接展示出来。

热门AI工具

更多
墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1851

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

5064

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1809

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

30517

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3627

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3647

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1243

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

616

2023.08.10

Docker Desktop怎么设置端口映射
Docker Desktop怎么设置端口映射

本专题聚焦Docker Desktop容器端口映射与访问配置,整理从创建容器、设置端口绑定到验证本地服务访问的操作流程。针对端口被占用、映射配置错误、容器服务无法访问等情况,也提供相应的检查方向,方便用户完成端口配置。

0

2026.11.03

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn