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

Symfony 6.4 怎么创建文档系统?OpenAPI

云静姑娘_6004

云静姑娘_6004

发布时间:2026-08-08 21:07:07

|

158人浏览过

|

来源于php中文网

原创

必须先确认 Symfony 6.4 项目骨架类型,纯 API 骨架需手动安装 twig-bundle 和 web-profiler-bundle;再安装 NelmioApiDocBundle v4.12+,配置 openapi 信息、路由及 APP_URL 环境变量,并为控制器添加 OA 注解或 PHP 8 Attributes,最后访问 /api/doc 即可运行交互式 OpenAPI 文档。

symfony 6.4 怎么创建文档系统?openapi

要在 Symfony 6.4 项目中搭建可运行、可生成、可交互的 OpenAPI 文档系统,必须先明确:Symfony 本身不内置 OpenAPI 支持,需借助第三方 Bundle 集成,且不同骨架(skeleton vs website-skeleton)的初始依赖差异会直接影响安装路径。

确认项目骨架类型并补全基础依赖

打开终端,进入你的 Symfony 6.4 项目根目录,执行:
composer show | grep -E "(symfony/skeleton|symfony/website-skeleton)"

若输出包含 symfony/skeleton,说明是纯 API 骨架——它默认不含 Twig、WebProfiler 或任何模板渲染能力,而 OpenAPI UI(如 Swagger UI)需要 HTML 渲染支持;此时必须手动安装 twig-bundle 和 web-profiler-bundle,否则后续文档页面无法加载。
执行:
composer require twig-bundle web-profiler-bundle

若已是 symfony/website-skeleton,则跳过此步。但注意:web-server-bundle 已弃用,不要装它,否则会与内置 PHP 内置服务器冲突。

安装 OpenAPI 集成 Bundle

推荐使用 NelmioApiDocBundle(当前兼容 Symfony 6.4 的稳定版本为 v4.12+):

运行:
composer require nelmio/api-doc-bundle

该 Bundle 会自动执行 Flex recipe 注入配置。检查 config/bundles.php,确认存在:
Nelmio\ApiDocBundle\NelmioApiDocBundle::class => ['all' => true]

如果没自动注册,请手动添加这一行——【缺少这行会导致路由 /api/doc 不生效】

配置 OpenAPI 文档入口与路由

第一步:在 config/packages/nelmio_api_doc.yaml 中写入基础配置:

openapi: '
  info:
    title: "My API"
    version: "1.0.0"
  servers:
    - url: "%env(APP_URL)%"

第二步:确保路由已启用。打开 config/routes.yaml,添加:

Symfony Linux版
Symfony Linux版

Symfony Linux版整理 Symfony CLI 5.17.1 官方下载入口和 Symfony 框架安装配置说明。

下载

nelmio_api_doc:
  path: /api/doc
  controller: nelmio_api_doc.controller.swagger_ui

第三步:设置环境变量 APP_URL。编辑 .env 文件,写入:
APP_URL=http://localhost:8000

这一步不能跳过——【若 APP_URL 为空或格式错误,Swagger UI 加载时会报“Invalid spec format”错误】

为控制器添加 OpenAPI 注解

方法一:使用 PHPDoc 注解(最常用)
在 src/Controller/Api/UserController.php 的 action 方法上方添加:

/** * @OA\Get( * path="/api/users", * summary="获取用户列表", * @OA\Response(response="200", description="返回用户数组") * ) */

注意:需提前 use Nelmio\ApiDocBundle\Annotation as OA;

方法二:使用 Attributes(PHP 8+ 推荐)
替换为:

#[OA\Get( path: '/api/users', summary: '获取用户列表', responses: [new OA\Response(response: '200', description: '返回用户数组')] )]

这一步操作起来很简单,直接把注解写在 controller 方法上就行。但必须确保控制器类名和命名空间正确,否则注解不会被扫描到。

启动服务并访问文档

执行:
php -S localhost:8000 -t public

浏览器访问:
http://localhost:8000/api/doc

页面应显示交互式 Swagger UI,左侧列出所有带 OpenAPI 注解的端点。若页面空白或 404,请回查 routes.yaml 是否拼写错误、APP_URL 是否设值、以及 NelmioApiDocBundle 是否在 bundles.php 中启用。

热门AI工具

更多
豆包大模型

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

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

Lovart
Lovart Hot

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

DeepSeek

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

WorkBuddy

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

LibLibAI
LibLibAI Hot

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

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

相关专题

更多
PHP Symfony框架
PHP Symfony框架

本专题专注于PHP主流框架Symfony的学习与应用,系统讲解路由与控制器、依赖注入、ORM数据操作、模板引擎、表单与验证、安全认证及API开发等核心内容。通过企业管理系统、内容管理平台与电商后台等实战案例,帮助学员全面掌握Symfony在企业级应用开发中的实践技能。

4357

2025.09.11

Aionclaw智能助手介绍
Aionclaw智能助手介绍

本专题汇总了AionClaw(AI龙虾助手)的功能介绍与在线使用入口。AionClaw是杭州趣猿人工智能有限公司推出的桌面级AI智能体,能直接在电脑上读写文件、运行脚本、操作浏览器,自动交付Word、PPT、Excel等成品。

20

2026.09.20

AionClaw AI智能体与电脑自动化任务执行功能使用教程
AionClaw AI智能体与电脑自动化任务执行功能使用教程

AionClaw专题整理AI智能体与电脑自动化相关功能使用教程,涵盖安装部署、AI任务执行、Skills技能、文件处理、浏览器控制、电脑操作、持久记忆、聊天工具连接以及办公、编程和内容创作等功能,帮助用户快速掌握AionClaw的实际使用方法。

0

2026.09.20

AI视频生成软件推荐
AI视频生成软件推荐

本专题汇总了当前主流的AI视频生成软件推荐与排行榜单,涵盖seko、AniShort、剧云、Lovart、LiblibAI及立刻mv等热门工具。同时整理了各软件在文生视频、图生视频、时长限制、画质表现及免费额度等方面的差异对比,助您快速选对适合创作需求的AI视频生成工具。

180

2026.09.16

ai生成视频的工具免费版合集
ai生成视频的工具免费版合集

本专题汇总了当前免费AI生成视频工具的排行榜与推荐清单,涵盖seko、讯飞智作、AniShort及剧云、Lovart等多模型集成平台。同时整理了各工具的免费额度、输出时长、水印政策及适用场景差异,助您快速选择合适工具开启AI视频创作。

100

2026.09.16

Pandas时间序列分析与可视化报表
Pandas时间序列分析与可视化报表

本专题整理Pandas日期转换、时间索引、重采样、滚动窗口、时区处理、plot绘图、Styler表格样式和报表输出方法。

80

2026.09.16

Pandas数据筛选索引与清洗处理
Pandas数据筛选索引与清洗处理

本专题整理Pandas中的loc、iloc、条件筛选、query查询、缺失值处理、重复值删除、类型转换和字符串列清洗方法。

60

2026.09.16

Pandas数据读取导入与文件导出处理
Pandas数据读取导入与文件导出处理

本专题整理Pandas读取CSV、Excel、JSON、SQL、Parquet等文件的方法,以及to_csv、to_excel、to_sql和to_parquet等常用数据导出流程。

40

2026.09.16

GDB怎么设置断点
GDB怎么设置断点

本专题介绍GDB按照函数名、源代码行号和文件位置设置断点的方法,详细说明run、continue、next、step等命令的配合使用,帮助定位程序崩溃、逻辑异常及代码未按预期执行的问题。

400

2026.09.11

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Symfony 官方文档
Symfony 官方文档

共0课时 | 0人学习

Composer手册
Composer手册

共0课时 | 0人学习

Symfony5【从0开始开发博客系统】
Symfony5【从0开始开发博客系统】

共120课时 | 15万人学习

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

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