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

云静姑娘_6004

云静姑娘_6004

2026-08-08

158人浏览

原创

必须先确认 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 中启用。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
PHP Symfony框架
PHP Symfony框架

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

2025.09.11

4357

17

Vibeknow在线使用入口合集
Vibeknow在线使用入口合集

本专题汇总了Vibeknow在线创作视频的官方入口及网页版使用教程,涵盖PPT、PDF、Word等文档一键转讲解视频的核心操作,并整理了免费版水印规则与手机端浏览器访问指南,助你快速将知识内容视频化。

2026.09.21

0

20

NumPy随机数文件读写与dtype数据类型
NumPy随机数文件读写与dtype数据类型

本专题整理 NumPy 随机数、文件读写与 dtype 数据类型相关教程,覆盖 Generator/random、随机数种子、正态分布采样、npy/npz/CSV/TXT 保存读取、loadtxt/savetxt、memmap、大文件处理、astype 类型转换、结构化 dtype、整数溢出和精度丢失等场景。

2026.09.21

0

24

NumPy矩阵运算与线性代数计算
NumPy矩阵运算与线性代数计算

本专题整理 NumPy 矩阵运算与线性代数计算相关教程,覆盖矩阵乘法、dot 与 @ 运算符、逆矩阵、行列式、特征值与特征向量、SVD、线性方程组、欧氏距离、矩阵分解和大规模矩阵性能优化等内容,帮助读者掌握 np.linalg 与矩阵计算实战。

2026.09.21

0

20

NumPy广播机制数学运算与统计分析
NumPy广播机制数学运算与统计分析

本专题整理 NumPy 广播机制、数组数学运算与统计分析相关教程,覆盖广播规则、维度对齐、矩阵与数组加减除法、向量化计算、均值方差、分位数、中位数、直方图和 unique 频次统计等场景,帮助读者掌握 ndarray 高效计算与统计处理方法。

2026.09.21

0

17

NumPy数组创建索引切片与数据选择
NumPy数组创建索引切片与数据选择

本专题整理 NumPy 数组创建、索引、切片与数据选择相关教程,覆盖 np.array、zeros/ones、多维数组形状、基础切片、花式索引、布尔索引、条件筛选、视图与副本等常用场景,帮助读者系统掌握 ndarray 数据构造与高效提取方法。

2026.09.21

0

12

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

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

2026.09.20

20

13

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

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

2026.09.20

0

15

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

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

2026.09.16

200

9

热门下载

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

精品课程

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

共0课时 | 0人学习

Composer手册
Composer手册

共0课时 | 0人学习

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

共120课时 | 15万人学习