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

Python Django接口文档怎么自动生成_集成drf-spectacular库

酷萱姑娘_9740

酷萱姑娘_9740

发布时间:2026-04-15 10:02:06

|

457人浏览过

|

来源于php中文网

原创

能,drf-spectacular提供更现代的OpenAPI 3.0生成能力,默认集成swagger-ui和redoc;需正确配置DEFAULT_SCHEMA_CLASS并挂载路由,自定义ViewSet方法须用@extend_schema显式标注,Serializer字段描述优先取help_text。

python django接口文档怎么自动生成_集成drf-spectacular库

drf-spectacular 能不能直接替代 Swagger UI?

能,但不是“替代”,而是提供更现代、更符合 DRF 习惯的 OpenAPI 3.0 生成能力。它不自带 UI,但默认集成了 swagger-ui 和 redoc 两个前端渲染器,开箱即用。如果你之前用过 drf-yasg,会发现 drf-spectacular 对 ViewSet、Serializer、@extend_schema 的支持更自然,且对泛型视图和类视图方法级注解更友好。

安装和基础配置三步走

别跳过中间步骤,尤其是 DEFAULT_SCHEMA_CLASS 配置,漏掉会导致 get_schema_view() 返回空或 404。

  • 运行 pip install drf-spectacular
  • 在 INSTALLED_APPS 中添加 'drf_spectacular'
  • 在 REST_FRAMEWORK 配置里加:
    "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema"

然后在主 urls.py 中挂载路由:

from drf_spectacular.views import SpectacularAPIView, SpectacularSwaggerView, SpectacularRedocView

urlpatterns = [
    path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
    path('api/schema/swagger-ui/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
    path('api/schema/redoc/', SpectacularRedocView.as_view(url_name='schema'), name='redoc'),
]

ViewSet 方法没出现在文档里?检查 @extend_schema 位置

drf-spectacular 默认只扫描 list、retrieve、create 等标准动作。自定义方法(比如 def publish(self, request))必须显式标注,否则不会进 OpenAPI。

Sakura python draw
Sakura python draw

使用Python的turtle和random库,递归绘制分形樱花树,并动画模拟花瓣自然飘落效果。

下载

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

  • 在方法上加装饰器:
    @extend_schema(description="发布文章,需 status=1")
  • 如果返回自定义响应体,补上 responses 参数:
    @extend_schema(responses={200: ArticleSerializer})
  • 注意:不要在类级别用 @extend_schema_view 覆盖整个 ViewSet 后,又在方法上重复加 —— 容易覆盖失效

常见错误现象:publish 接口在 Swagger UI 里完全不可见,或点击后报 405 Method Not Allowed,其实是 schema 没声明该 endpoint 导致前端没生成对应请求按钮。

Serializer 字段描述不显示?用 help_text 或 @extend_schema_field

drf-spectacular 优先读取字段的 help_text 作为 description。没设就留空,看着像“文档缺失”。

  • 推荐写法:
    title = serializers.CharField(help_text="文章标题,最大长度 100")
  • 动态描述(比如根据环境变)用 @extend_schema_field:
    @extend_schema_field(serializers.CharField(help_text="仅测试环境可用"))
  • 注意:字段级 label 不会进 OpenAPI description,别指望它起作用

容易被忽略的是嵌套 Serializer 的字段 —— 如果外层用了 fields = '__all__',但内层字段没写 help_text,那整块 description 就是空的,看起来像接口设计不规范。

热门AI工具

更多
咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

DeepSeek

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

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

WorkBuddy

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

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

豆包大模型

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

相关专题

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

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

1671

2023.07.20

python能做什么
python能做什么

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

4144

2023.07.25

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

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

1669

2023.07.31

python教程
python教程

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

23997

2023.08.03

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

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

2947

2023.08.04

python eval
python eval

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

2967

2023.08.04

scratch和python区别
scratch和python区别

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

1143

2023.08.11

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

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

596

2023.08.10

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

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

精品课程

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

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