0

0

composer怎么给项目集成Swagger文档工具_composer引入swagger-php依赖【实操】

冰火之心

冰火之心

发布时间:2026-01-15 17:57:16

|

207人浏览过

|

来源于php中文网

原创

装 zircote/swagger-php 后需三步:配置 Composer autoloader 映射 OpenApi\Annotations 命名空间,用 vendor/bin/openapi 命令生成 openapi.json 到 public/ 目录,再通过 swagger-ui-dist 提供前端 UI 预览。

composer怎么给项目集成swagger文档工具_composer引入swagger-php依赖【实操】

直接装 zircote/swagger-php 就够了,但别只 run install

装上 zircote/swagger-php 并不等于项目能自动生成 Swagger 文档。它只是个 PHP 注解解析器,本身不带 Web UI、不启动服务、也不自动扫描路由。你得自己配注解位置、加生成命令、再把输出喂给 Swagger UI 或 OpenAPI 工具链。

composer require zircote/swagger-php 后必须手动加 autoloader 配置

默认安装后,@OA\Info@OA\Get 这类注解不会被自动识别——PHP 不会主动加载注解类,除非你告诉 Composer 哪些命名空间要扫。常见漏配导致报错:Class "OpenApi\Annotations\Get" not found

  • composer.json"autoload" 下加 PSR-4 映射(Swagger-PHP 4.x 要求):
"autoload": {
  "psr-4": {
    "App\\": "app/",
    "OpenApi\\Annotations\\": "vendor/zircote/swagger-php/src/Annotations/"
  }
}
  • 运行 composer dump-autoload 生效
  • 不加这行,哪怕 use OpenApi\Annotations as OA; 也救不了 —— 类根本没进自动加载器

生成文档用 vendor/bin/openapi,不是 artisan 或 php serve

Swagger-PHP 提供的是命令行工具 openapi,不是 Laravel 的 php artisan 命令,也不是内置服务器。你得明确指定源码路径、输出格式和目标文件。

  • 基础生成命令(假设 API 注解写在 app/Http/Controllers):
vendor/bin/openapi app/Http/Controllers --output public/openapi.json
  • --format yaml 输出 YAML(适合 Swagger UI 加载)
  • --annotations ./config/swagger 可额外指定注解配置目录(比如全局 @OA\Info 单独放)
  • 别指望它自动读 routes/web.php —— 它只认 PHP 文件里的 PHPDoc 注解

本地预览需额外搭 UI,推荐用 swagger-ui-dist

openapi.json 是纯数据,浏览器打不开。得用前端 UI 渲染。最轻量做法是直接引入官方 dist 包:

造梦阁AI
造梦阁AI

AI小说推文一键成片,你的故事值得被看见

下载

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

  • 执行:composer require --dev swagger-api/swagger-ui-dist
  • vendor/swagger-api/swagger-ui-dist 下的文件复制到 public/swagger/
  • public/swagger/index.html 里改 url: "/openapi.json"
  • 访问 http://your-app.test/swagger/ 即可交互式查看

注意:如果你用的是 Laravel,别把 openapi.json 放在 resources/ 下——它必须能被 Web 服务器直接 HTTP 访问,所以放 public/ 是唯一靠谱路径。

真正卡住人的地方,从来不是“装没装上”,而是注解没被 autoload 扫到、生成命令没指定对目录、或者生成完忘了配静态资源路径。三步缺一不可,少一步页面就空白或报 404。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2534

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1605

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1499

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

952

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1416

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1234

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1445

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

Golang gRPC 服务开发与Protobuf实战
Golang gRPC 服务开发与Protobuf实战

本专题系统讲解 Golang 在 gRPC 服务开发中的完整实践,涵盖 Protobuf 定义与代码生成、gRPC 服务端与客户端实现、流式 RPC(Unary/Server/Client/Bidirectional)、错误处理、拦截器、中间件以及与 HTTP/REST 的对接方案。通过实际案例,帮助学习者掌握 使用 Go 构建高性能、强类型、可扩展的 RPC 服务体系,适用于微服务与内部系统通信场景。

8

2026.01.15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.7万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 7万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号