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

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

雨浩姑娘_3903

雨浩姑娘_3903

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

|

359人浏览过

|

来源于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-json 和 php-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。

arcgis-js
arcgis-js

提供 ArcGIS Maps SDK for JavaScript 开发辅助,涵盖 2D/3D 地图视图、图层管理、数据可视化、空间分析等功能模块的参考和示例指导。

下载
  • 正确调用方式(推荐相对路径):
    ./vendor/bin/swagger app/Http/Controllers --output storage/api-docs
  • app/Http/Controllers 是 Laravel 典型控制器路径;请按你实际代码结构替换,例如 src/Api 或 modules/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。

热门AI工具

更多
WorkBuddy

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

Laper
Laper Hot

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

DeepSeek

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

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

豆包大模型

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

相关专题

更多
PHP Symfony框架
PHP Symfony框架

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

6037

2025.09.11

laravel组件介绍
laravel组件介绍

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

877

2024.04.09

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

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

855

2024.04.09

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

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

2508

2024.04.09

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

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

4641

2024.04.10

laravel入门教程
laravel入门教程

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

6770

2025.08.05

laravel实战教程
laravel实战教程

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

4456

2025.08.05

laravel面试题
laravel面试题

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

8369

2025.08.05

Uvicorn 报错与问题解决教程
Uvicorn 报错与问题解决教程

本专题汇总了Uvicorn服务器常见问题与报错解决的教程合集,涵盖启动失败、端口占用、模块导入错误、事件循环冲突及热重载失效等典型故障的排查思路。同时整理了多进程与Worker配置、SSL/HTTPS证书报错、跨域与代理配置等实战解决方案,助你快速定位并解决Uvicorn运行中的各类问题。

0

2026.11.02

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习

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

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