0

0

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

冰火之心

冰火之心

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

|

207人浏览过

|

来源于php中文网

原创

装 zircote/swagger-php 后需三步:配置 Composer autoloader 映射 OpenApiAnnotations 命名空间,用 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 配置

默认安装后,@OAInfo@OAGet 这类注解不会被自动识别——PHP 不会主动加载注解类,除非你告诉 Composer 哪些命名空间要扫。常见漏配导致报错:Class "OpenApiAnnotationsGet" 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 OpenApiAnnotations 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 可额外指定注解配置目录(比如全局 @OAInfo 单独放)
  • 别指望它自动读 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。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

341

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

296

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

795

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

386

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

146

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

86

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

84

2025.08.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

758

2026.03.04

Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建
Nginx跨平台安装实操指南:Windows、macOS与Linux环境快速搭建

本指南详解Nginx在Windows、macOS及Linux系统的安装全流程。涵盖官方包解压、Homebrew一键部署、APT/YUM源配置及Docker容器化方案。无论新手或开发者,均可快速搭建运行环境,掌握跨平台核心指令,为后续配置与调优奠定坚实基础。

10

2026.03.16

热门下载

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

精品课程

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

共137课时 | 13.7万人学习

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

共6课时 | 11.3万人学习

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

共13课时 | 1.0万人学习

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

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