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

ThinkPHP如何做接口文档_Swagger注解自动生成API文档【教程】

梦浩姑娘_9812

梦浩姑娘_9812

发布时间:2026-05-18 12:43:40

|

653人浏览过

|

来源于php中文网

原创

Swagger注解不生效主因是工具链未配对、注释格式错误或扫描路径不准;需装zircote/swagger-php与openapi/openapi,注释紧贴方法、用完整命名空间、path匹配真实路由,生成时指定正确目录并确保UTF-8无BOM,UI须通过HTTP访问且配置@OA\Server。

thinkphp如何做接口文档_swagger注解自动生成api文档【教程】

ThinkPHP 项目里 Swagger 注解不生效,基本不是框架问题,而是工具链没配对、注释没写对、路径没扫到——三者占了 90% 的失败原因。

装对包:zircote/swagger-php + openapi/openapi 缺一不可

很多人卡在第一步:vendor/bin/openapi 命令根本不存在,或者运行后输出空 JSON。这不是 ThinkPHP 限制,是依赖没装全。

  • 必须执行 composer require zircote/swagger-php(注意不是 swagger-php-dev 或旧版 swagger-php)
  • v4+ 版本已剥离注解类,必须额外装 composer require openapi/openapi,否则 @OA\Get 这类注释会被完全忽略
  • 检查 vendor/zircote/swagger-php/src/Annotation.php 是否存在;若不存在,说明装的是废弃的 v2 分支
  • 别手动 use OpenApiAnnotations as OA —— 扫描器只识别全局命名空间下的 @OA\Xxx

注释写法:紧贴 + 完整命名空间 + 路径对齐真实路由

ThinkPHP 的路由前缀(比如 api/)不会被自动注入到文档里,@OA\Get(path="/user") 和实际访问地址 /api/user 不一致,文档就等于废的。

  • 注释块必须紧贴方法声明上方,中间不能有空行;例如 /** @OA\Get(...) */ public function index() 合法,换行后就失效
  • 所有注释必须用完整命名空间:@OA\Get,不是 @Get 或 @SWGGet(v2 已废弃)
  • path 值必须和最终对外暴露的 URL 完全一致,包括 /api/v1 这类前缀;ThinkPHP 的 route 配置或 group 中间件不参与自动推导
  • 参数不能靠函数签名猜:function detail($id) 不会自动生成 id 查询参数;必须显式写 @OA\Parameter(name="id", in="query", ...)
  • JSON Body 提交必须用 @OA\RequestBody + @OA\JsonContent 描述结构,光写 @OA\Property 没用

生成命令:指定目录要准,权限和编码不能错

常见现象是命令跑通但 openapi.json 里 paths 为空,或只扫到部分控制器——大概率是扫描路径没覆盖到你的实际代码位置。

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

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

下载

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

  • ThinkPHP5 默认控制器在 app/api/controller/,ThinkPHP6 多为 app/controller/,生成时路径必须精确指向这些目录,例如:./vendor/bin/openapi app/controller/ -o public/docs/openapi.json
  • 确保目标 PHP 文件能被 Composer 自动加载(即在 composer.json 的 autoload.psr-4 或 classmap 中注册)
  • Linux/macOS 下注意文件权限:如果控制器文件属主不是当前执行用户,openapi 可能静默跳过
  • 文件编码必须是 UTF-8 无 BOM;BOM 会导致注释解析失败,且无报错提示
  • 生成后务必打开 openapi.json 看一眼是否有 "openapi": "3.0.3" 和真实 "paths",没有就说明扫描失败

接入 Swagger UI:静态托管 + 正确 URL + 必须走 HTTP

很多人双击 index.html 打开 UI,看到 Failed to load spec 就以为是生成失败——其实是浏览器 CORS 策略直接拦截了本地 file 协议读取 JSON。

  • 把 Swagger UI 解压到 public/docs/(ThinkPHP 的 Web 根目录下),不要放 app/ 或 runtime/ 里
  • 修改 public/docs/index.html 中的 url 字段为 "./openapi.json" 或绝对路径如 "/docs/openapi.json"
  • 必须通过 Web 服务器访问,例如启动内置服务:php -S localhost:8000 -t public,然后浏览器打开 http://localhost:8000/docs/
  • 别漏掉 @OA\Server;没这个字段,UI 的 “Try it out” 功能会默认发请求到 /,必然 404。加在 @OA\Info 里:@OA\Server(url="http://localhost:8000")

最易被忽略的一点:ThinkPHP 的中间件(如鉴权、跨域)不影响文档生成,但会影响 UI 测试时的真实请求结果;文档里的 @OA\Response 必须严格对应你实际返回的 JSON 结构,哪怕只是多一个 data 包裹层,也要在 @OA\JsonContent 里写清楚。

相关文章

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

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

下载

相关标签:

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

热门AI工具

更多
讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

豆包大模型

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

Atoms
Atoms Hot

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

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

WorkBuddy

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

DeepSeek

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

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

切问学术

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

相关专题

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

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

9984

2023.09.01

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

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

5941

2023.10.11

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

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

2075

2023.10.11

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

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

3708

2023.10.23

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

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

4414

2023.10.23

html怎么上传
html怎么上传

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

3451

2023.11.03

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

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

4917

2023.11.09

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

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

3862

2023.11.13

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

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

精品课程

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

共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