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

Composer如何安装Swagger生成_Composer Swagger文档生成教程【推荐】

酷墨同学_1936

酷墨同学_1936

发布时间:2026-03-28 18:27:12

|

606人浏览过

|

来源于php中文网

原创

必须用 composer require zircote/swagger-php 安装,它是唯一支持 PHP 8+ 属性注解(#[OA\Get])的官方维护版本;旧版 @SWG 不兼容 PHP 8.2+,全局安装易冲突,应项目内安装并使用 ./vendor/bin/openapi 命令生成文档。

composer如何安装swagger生成_composer swagger文档生成教程【推荐】

直接结论:用 composer require zircote/swagger-php 安装,别碰全局安装或老版本。 它是当前 PHP 8+ 环境下唯一能正确解析属性注解(#[OA\Get])的官方维护版本;旧版 swagger-php(无命名空间、用 @SWG)已彻底不兼容 PHP 8.2+ 的类型系统和属性语法。

为什么必须用 zircote/swagger-php 而不是其他名字?

很多人搜“swagger php composer”会误装 swagger-api/swagger-php 或过时的 fork,结果运行报错:Attribute "OA\Get" does not exist 或直接跳过注解——因为那些包没迁移到 PHP 8 属性支持,也不再更新。官方唯一认可的包就是 zircote/swagger-php,从 v4.8 开始全面支持 #[OA\*] 属性写法,且与 Laravel/Slim/Yii2 等框架路由逻辑解耦干净。

  • 安装命令只有一条:composer require zircote/swagger-php
  • 全局安装风险高:composer global require zircote/swagger-php 会导致多项目版本冲突,且 openapi 命令可能找不到 autoload —— 推荐始终项目内安装
  • PHP 8.2+ 用户可加一个增强包提升类型推断:composer require radebatz/type-info-extras,它能让 @OA\Property 自动读取 PHP 类型声明(如 string $name → type="string"),省掉一半手写

openapi 命令怎么调?路径和输出格式别写错

装完后,生成命令不是 swagger(那是 Node.js 版),也不是 php ./vendor/zircote/.../bin/swagger(v2/v3 遗留路径),而是统一的:./vendor/bin/openapi。这个二进制脚本由 Composer 自动生成,自动加载项目 autoloader,确保能识别你代码里的类和命名空间。

Discussion Composer
Discussion Composer

围绕关键发现、作用机制、临床相关性及研究局限性展开讨论。适用于撰写或优化任何生物医学论文的“讨论(Discussion)”部分——包括结果解读、与既往文献关联、阐释意外发现、界定研究局限性,以及撰写结论。当用户输入以下任一指令时也会自动触发该功能: - “write my discussion” - “help me discuss my findings” - “how do I compare to prior studies” - “write the limitations par

下载
  • 基础用法:./vendor/bin/openapi src/ -o openapi.yaml —— 扫描 src/ 目录下所有 PHP 文件,输出 OpenAPI 3.0 YAML
  • 要输出 JSON?加 --format json:./vendor/bin/openapi src/ --format json -o openapi.json
  • 如果项目有常量定义(如 APP_ENV),需提前加载:./vendor/bin/openapi --bootstrap constants.php src/ -o openapi.yaml
  • 常见错误:Could not open input file: ./vendor/bin/openapi → 检查是否用了 --no-bin-dir 安装 Composer,或权限问题;用 ls -l ./vendor/bin/ 确认文件存在且可执行

注解写在哪?空行、位置、命名空间一个都不能错

Swagger-PHP 不是“扫描函数签名”,它只认 PHPDoc 块里的 @OA\* 注解,而且对格式极其敏感:注解必须紧贴目标元素(类/方法/参数)上方,中间不能有任何空行,否则整个块被忽略。

  • 正确写法(无空行):
    /** @OA\Get(path="/api/users") */ public function index() { ... }
  • 错误写法(空行导致失效):
    /** @OA\Get(path="/api/users") */ 
    <p>public function index() { ... }
  • 必须 use 别名:use OpenApi\Annotations as OA;,否则 @OA\Get 会被当成普通文本,不解析
  • 参数名必须和实际接收一致:比如 @OA\Parameter(name="page", in="query"),但控制器里是 $request->getQueryParam('p') → 文档和真实请求就对不上,前端调试必 404
  • Body 提交必须显式写 @OA\RequestBody + @OA\JsonContent,光写 @OA\Property 不会出现在请求体结构里

生成的文档为啥点 “Try it out” 就 404?

因为默认生成的 openapi.yaml 里没有 servers 字段,Swagger UI 不知道该往哪个域名+端口发请求。这不是后端没跑起来,是文档缺配置。

  • 补上服务器地址最简单:
    /** @OA\Info(title="My API", version="1.0") @OA\Server(url="https://api.example.com/v1") */
  • 开发环境可配多个:@OA\Server(url="http://localhost:8000/api") 和 @OA\Server(url="https://staging.example.com/api")
  • 如果不写 @OA\Server,Swagger UI 默认用当前页面 URL 的 origin(比如 http://localhost/swagger-ui/)拼路径,显然不对
  • 另一个隐形坑:path="/users" 和真实路由前缀(如 /api/v1/users)不一致 → 文档路径和接口实际路径错位,前端照着文档调就 404

最容易被忽略的是:Swagger-PHP 不读取任何框架路由配置,它只认你写的 path 字符串。所以哪怕你用 Laravel 的 Route::get('users', ...),也得手动在注解里写成 path="/api/v1/users" —— 这个映射必须人工对齐,自动化靠不住。

热门AI工具

更多
UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

Laper
Laper Hot

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

WorkBuddy

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

DeepSeek

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

豆包大模型

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

音述AI
音述AI Hot

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

UpDream
UpDream Hot

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

相关专题

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

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

857

2024.04.09

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

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

835

2024.04.09

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

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

2488

2024.04.09

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

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

4221

2024.04.10

laravel入门教程
laravel入门教程

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

6070

2025.08.05

laravel实战教程
laravel实战教程

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

4016

2025.08.05

laravel面试题
laravel面试题

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

7549

2025.08.05

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

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

1456

2026.03.04

Playwright 测试失败怎么办
Playwright 测试失败怎么办

Playwright测试失败专题汇集超时、定位器匹配、浏览器提前关闭、依赖与插件配置、文件上传、SSL及Docker启动等故障文章,并介绍通过截图、报告和Trace定位错误。

0

2026.10.21

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpMyAdmin 安装文档
phpMyAdmin 安装文档

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习

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

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