0

0

composer如何安装并在项目中使用Swagger生成API文档_composer实战教程【教程】

冰火之心

冰火之心

发布时间:2026-01-18 16:33:02

|

319人浏览过

|

来源于php中文网

原创

应安装 zircote/swagger-php:composer require zircote/swagger-php;生成命令为 ./vendor/bin/swagger [源码路径] --output [输出目录];注解须统一用 @OA\ 前缀,JSON 需通过 Swagger UI 静态托管访问。

composer如何安装并在项目中使用swagger生成api文档_composer实战教程【教程】

Composer 本身不提供 Swagger 文档生成功能,它只是 PHP 的依赖管理工具;真正生成文档的是 swagger-php(注解式)或 zircote/swagger-php(官方维护分支),配合 swagger-ui 渲染。直接运行 composer install swagger 会失败——因为没这个包。

如何用 Composer 安装 swagger-php 并支持注解解析

必须安装的是 zircote/swagger-php,它是目前主流的 PHP 注解驱动 Swagger/OpenAPI 生成器。它不依赖 Laravel 或 Symfony,但需要 PHP 7.4+ 和反射扩展启用。

  • 在项目根目录执行:
    composer require zircote/swagger-php
  • 确保你的 PHP 环境已启用 php-jsonphp-reflection 扩展(绝大多数环境默认开启)
  • 不要安装 swagger-api/swagger-php(已废弃,最后更新于 2016 年)
  • 如果项目用 Laravel,可额外加 darkaonline/l5-swagger,但它本质是封装了 zircote/swagger-php + UI 集成

生成 JSON 文档时常见的路径与命令错误

swagger-php 是命令行工具,但不是全局命令;它由 Composer 自动注册到 vendor/bin/swagger。直接敲 swagger 会报“command not found”,除非你配置了 $PATH

云雀语言模型
云雀语言模型

云雀是一款由字节跳动研发的语言模型,通过便捷的自然语言交互,能够高效的完成互动对话

下载
  • 正确调用方式(推荐相对路径):
    ./vendor/bin/swagger app/Http/Controllers --output storage/api-docs
  • app/Http/Controllers 是 Laravel 典型控制器路径;请按你实际代码结构替换,例如 src/Apimodules/v1
  • 输出目录(--output)必须存在且可写,否则报 failed to open stream: Permission denied
  • 若提示 Class 'OpenApi\Annotations\OpenApi' not found,说明用了旧版注解命名空间,应统一为 @OA\OpenApi(对应 use OpenApi\Annotations as OA;

如何让生成的 JSON 被 Swagger UI 正确加载

生成的 openapi.json 只是数据,需前端 UI 渲染。Swagger UI 不是 PHP 包,不能靠 Composer 自动部署;常见做法是静态托管或反向代理。

  • 下载最新 Swagger UI:从 GitHub Releases 解压 dist/ 目录到项目 public/swagger-ui/
  • public/swagger-ui/index.html 中修改 url 指向你的 JSON 路径,例如:
    url: "/storage/api-docs/openapi.json"
  • 确保 Web 服务器允许访问 storage/api-docs/(Laravel 默认禁止,需在 public/storage 建软链或配置 Nginx alias)
  • 别把 openapi.json 放在 storage/app/ 下——它不在公开路径,Nginx/Apache 默认拒访

最易被忽略的是注解语法版本和 OpenAPI 版本绑定关系:@OA\Get 对应 OpenAPI 3.x,不兼容 Swagger 2.0 注解(如 @SWG\Get);混用会导致解析中断且无明确报错。检查你所有控制器注解是否全部以 @OA\ 开头,并确认 zircote/swagger-php 版本 ≥ 4.0。

相关专题

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

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

2644

2023.09.01

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

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

1656

2023.10.11

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

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

1513

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数据库相关内容,可以阅读本专题下面的文章。

1418

2023.10.23

html怎么上传
html怎么上传

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

1234

2023.11.03

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

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

1448

2023.11.09

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

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

1306

2023.11.13

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

68

2026.01.16

热门下载

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

精品课程

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

共137课时 | 8.8万人学习

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

共6课时 | 7.8万人学习

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

共13课时 | 0.9万人学习

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

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