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

ThinkPHPSwagger集成教程

阿宇君_9026

阿宇君_9026

发布时间:2026-05-22 10:45:47

|

691人浏览过

|

来源于php中文网

原创

先确认PHP版本≥7.4且启用json、mbstring扩展;若PHP 7.4则用composer require zircote/swagger-php:^3.4.1,避免v4+版本冲突;检查是否被安全插件拦截,删vendor重装;确保注解写在public方法PHPDoc中并显式扫描对应路径。

thinkphpswagger集成教程

composer require zircote/swagger-php 失败怎么办

装不上就别往下走了,90% 的后续问题都根源于这一步卡住。不是“稍后再试”,而是必须当场解决。

  • 国内网络下直接 composer require zircote/swagger-php 极大概率超时或 404 → 先执行 composer config repo.packagist composer https://packagist.phpcomposer.com(注意是 phpcomposer.com,不是旧的 laravel-china.org)
  • 用宝塔/AMH 面板 Shell 执行报 HOME or COMPOSER_HOME must be set → 别在面板里硬刚,SSH 登录服务器后执行
  • Windows WSL 或 Docker 环境下 vendor/bin/openapi 报 “Permission denied” → 运行 chmod +x vendor/bin/openapi
  • 命令返回 “Successfully installed”,但 vendor/zircote/swagger-php 目录不存在 → 检查是否被 Composer 插件拦截(比如某些安全插件会静默跳过),删掉 vendor 重装

@OA\Get 注解写了却没出现在 swagger.json 里

swagger-php 是静态扫描器,它不运行代码,只读文件。你写的注解“看不见”,基本是路径、可见性或路由三者之一断了链。

  • 注解必须写在 public 方法的 PHPDoc 块内,private、protected、__invoke、中间件、模型方法里的注释全被忽略
  • 控制器命名空间如 app\api\v2\UserController,扫描命令必须显式包含该路径:vendor/bin/openapi app/api/v2/ --output public/openapi.json,别只扫 app/controller/
  • 路由没真正绑定到该方法 → 检查 route/app.php 是否有类似 Route::get('api/users', 'api.v2.UserController@list'); 这样的显式声明;资源路由 Route::resource('users', 'UserController') 默认不扫描,得加 ->only(['index', 'show'])
  • 注解里写的 path="/api/users" 必须和实际可访问的 URL 完全一致(包括前缀、大小写、斜杠结尾),否则生成的 JSON 里接口字段为空

嵌套参数 @param array $data 不解析?

ThinkPHP 生态(尤其是 think-swagger 或原生 swagger-php 3.x)对 PHPDoc 的解析非常严格,@param array 这种写法等于没写 —— 它不会递归展开数组结构,也不会识别内部字段类型。

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
  • JSON body 中的嵌套对象(如 {"user": {"name": "a", "age": 18}})必须扁平化拆解:@param string $user_name、@param int $user_age
  • URL 查询参数或表单字段中的嵌套(如 filter[status]=1&filter[name]=test)同样不能写 @param array $filter,而要写成 @param string $filter_status、@param string $filter_name
  • 如果字段名含点号或中括号(如 user.profile.nick),Swagger UI 可能渲染异常 → 改用下划线风格(user_profile_nick)并配合 @OA\Schema 的 description 字段说明原始结构

swagger-ui 打开空白或报 Failed to load API definition

这不是 PHP 错误,而是前端加载失败。Swagger UI 只需要一个合法的 JSON 文件和正确的访问路径,其余全是环境配置问题。

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

  • public/openapi.json 必须能被 Web 服务器直接 HTTP 访问(例如 https://yourdomain.com/openapi.json),不能放在受路由保护或权限限制的目录下
  • Apache 用户检查 .htaccess 是否拦截了 .json 后缀(加一行 <Files "*.json">Order Allow,DenyAllow from all</Files>)
  • Nginx 用户确认没有 location ~ \.json$ { deny all; } 类规则,且确保 openapi.json 文件 MIME 类型为 application/json(加 add_header Content-Type application/json;)
  • JSON 文件本身必须严格符合 OpenAPI 3.0 规范:字段名大小写敏感(responses 不是 Responses),@OA\Response 必须带 response="200" 字符串而非数字,schema 必须是对象,不能是空数组
Swagger 的核心逻辑其实就两件事:让 PHP 注释能被机器读懂,再让前端能稳稳拿到那个 JSON。所有坑都集中在这条链路上,而不是功能多复杂。最容易被忽略的是——你改完注解后,必须重新运行 vendor/bin/openapi 生成新 JSON,否则浏览器里看到的永远是旧的、甚至语法错误的内容。

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek

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

WorkBuddy

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

音述AI
音述AI Hot

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

豆包大模型

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

Laper
Laper Hot

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

相关专题

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

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

9524

2023.09.01

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

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

5741

2023.10.11

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

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

2055

2023.10.11

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

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

3568

2023.10.23

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

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

4254

2023.10.23

html怎么上传
html怎么上传

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

3331

2023.11.03

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

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

4737

2023.11.09

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

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

3722

2023.11.13

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

0

2026.09.29

热门下载

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

精品课程

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

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