讲师中心 微信公众号

工具推荐

视频效率加速
updream

一键生成高质量推广成片

SoundView
SoundView

字幕擦除翻译、配音口型同步

Seko
Seko

AI短剧一键生成成片

AniShort
AniShort

AI短剧协同制作平台

Python中怎么为Django的API自动生成Swagger在线文档?

雨晨酱_1699

雨晨酱_1699

发布时间:2026-09-12 06:03:37

|

751人浏览过

|

来源于php中文网

原创

drf-spectacular是目前最省心、兼容性最好、真正开箱即用的DRF OpenAPI文档方案,需安装配置、补全serializer注释及@extend_schema标注、显式声明认证与安全定义。

python中怎么为django的api自动生成swagger在线文档?

用 drf-spectacular 是目前最省心、兼容性最好、且真正开箱即用的方案。Django REST Framework 官方不维护 Swagger 集成,旧方案如 django-rest-swagger 已停更多年,强行用会卡在 DRF 3.12+ 和 OpenAPI 3 的兼容问题上。

安装与基础配置要一步到位

别碰 coreapi 或手动写 schema.yml——它们要么已弃用,要么维护成本极高。直接装 drf-spectacular 并配进 INSTALLED_APPS 和 URL 路由:

  • 运行 pip install drf-spectacular
  • 在 settings.py 的 INSTALLED_APPS 中加入 'drf_spectacular'
  • 在主 urls.py 里加路由:path('api/schema/', SpectacularAPIView.as_view(), name='schema') 和 path('api/schema/swagger-ui/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui')
  • 确保你的 API 视图类继承自 APIView、GenericAPIView 或 ViewSet,且用了标准的 serializer_class 或 get_serializer_class()

字段描述和请求体不显示?检查 serializer 注释和 @extend_schema

drf-spectacular 默认靠 serializer 的 help_text、label 和 docstring 推导字段说明。如果 Swagger 里字段没描述、或 POST body 空白,大概率是这些地方没填:

Biopython
Biopython

全面的分子生物学工具集。适用于序列操作、文件解析(FASTA/GenBank/PDB)、系统发育分析,以及通过 Bio.Entrez 以编程方式访问 NCBI/

下载
  • 给 serializers.CharField(help_text="用户手机号") 显式加 help_text
  • 对非标准动作(比如 @action(methods=['post'], detail=False)),必须用 @extend_schema(request=YourSerializer, responses={200: YourResponseSerializer}) 手动标注
  • 如果视图方法返回的是原始字典而非 serializer 实例,Swagger 无法自动推导结构,必须用 @extend_schema(responses={200: OpenApiTypes.OBJECT}) 或具体 schema

认证和权限信息不出现?补全 AUTHENTICATION_CLASSES 配置

Swagger UI 默认不会显示认证方式,除非你告诉它有哪些。常见坑是只配了 TokenAuthentication 却没在 schema 设置里声明:

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

  • 在 settings.py 加:SPECTACULAR_SETTINGS = {'SWAGGER_UI_AUTH_ACTIONS': {'ApiKeyAuth': {'type': 'apiKey', 'in': 'header', 'name': 'Authorization'}}}
  • 更稳妥的做法是在 SPECTACULAR_SETTINGS 中显式设置 'SECURITY_DEFINITIONS',例如:'Bearer': {'type': 'http', 'scheme': 'bearer', 'bearerFormat': 'JWT'}
  • 如果用了自定义 permission 类且依赖 request header,记得在 @extend_schema 的 security 参数里声明,否则 UI 不会自动带 Authorization 输入框

真正麻烦的不是生成文档,而是让每个 endpoint 的请求参数、响应结构、错误码都真实反映代码逻辑。很多人跑通首页就以为完成了,结果点开一个接口发现 body 是 {}、response 是 object——那基本等于没文档。花十分钟补全 help_text 和 @extend_schema,比后期靠人工写 wiki 强十倍。

热门AI工具

更多
小橡皮AI

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

豆包大模型

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

墨刀AI
墨刀AI Hot

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

WorkBuddy

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

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

火山引擎

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

DeepSeek

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

相关专题

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

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

1951

2023.07.20

python能做什么
python能做什么

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

5524

2023.07.25

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

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

1889

2023.07.31

python教程
python教程

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

33677

2023.08.03

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

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

3947

2023.08.04

python eval
python eval

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

3947

2023.08.04

scratch和python区别
scratch和python区别

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

1283

2023.08.11

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

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

636

2023.08.10

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

140

2026.11.12

热门下载

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

精品课程

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

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