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

TP6.0 怎样生成漂亮的 API 文档?Swagger 注解与自动生成【偷懒】

星静吖_6743

星静吖_6743

发布时间:2026-07-08 16:19:09

|

351人浏览过

|

来源于php中文网

原创

ThinkPHP 6.0 不解析 @api 等注解,需用 swagger-php 工具解析 @OA\Get 等 OpenAPI 注解生成文档;path 必须与 Route::get() 注册路径完全一致,且需正确配置 Swagger UI 才能展示交互式文档。

tp6.0 怎样生成漂亮的 api 文档?swagger 注解与自动生成【偷懒】

TP6 不认 @api 注解,别白写了

ThinkPHP 6.0 本身完全不解析任何 @api@param@return 这类注释——它们只是普通 PHP 注释,框架压根不会读。所谓“自动生成文档”,实际依赖的是 zircote/swagger-php 这个独立工具,它按 OpenAPI 3.0 标准解析 @OA\Get 等注解,再导出 JSON/YAML。

常见错误包括:

  • 在控制器方法上写 @api@param,结果生成空文件或报错 Warning: No operations defined
  • 混用 ThinkPHP 5.1 的 think-apidoc 插件(已废弃,不兼容 TP6)
  • 注解没放在 /** */ 块里,或者和方法之间隔了空行

@OA\Getpath 必须和路由注册完全一致

Swagger-PHP 不关心你的控制器路径或方法名,只认你通过 Route::get() 实际注册的 URL 路径。写错 path 就会导致接口不显示,或生成后 UI 里点击 404。

比如你在 route/app.php 里写了:

Route::get('api/v1/users', 'UserController@index');

那么注解必须是:

/**
 * @OA\Get(
 *   path="/api/v1/users",
 *   summary="获取用户列表"
 * )
 */

而不是 /users/indexapi/v1/users(缺开头斜杠)或 /api/v1/users/(结尾多斜杠)。

其他要点:

  • @OA\Post@OA\Put 同理,path 必须和 Route::post() 注册的路径一字不差
  • 路径中带变量的,如 Route::get('api/v1/users/{id}', ...),注解里写 path="/api/v1/users/{id}",并补上 @OA\Parameter
  • 所有 @OA\* 注解必须用 use OpenApi\Annotations as OA; 导入命名空间

生成 openapi.json 的两种可靠方式

推荐优先用命令行生成,稳定可控;动态路由方式容易因环境或缓存导致 JSON 内容陈旧。

ThinkPHP5.1企业站点快速开发-源码课件
ThinkPHP5.1企业站点快速开发-源码课件

ThinkPHP5.1企业站点快速开发

下载

方式一:终端执行(项目根目录)

./vendor/bin/openapi app/controller -o public/openapi.json

说明:

  • app/controller 是默认扫描路径,如有 modelservice 里也写了接口定义,可追加路径:app/controller app/model
  • -o 指定输出位置,建议放 public/ 下,方便 Web 直接访问
  • PHP 版本需 ≥ 7.4(swagger-php 4.x 强制要求)

方式二:加一个静态路由返回 JSON(仅开发调试用)

Route::get('api-docs', function () {
    return json_decode(file_get_contents(public_path('openapi.json')), true);
});

注意:不要用 file_get_contents 动态扫描源码生成,性能差且易出错;JSON 文件应由 CI/CD 或部署脚本预生成。

前端展示用 Swagger UI,不是“装个插件”就完事

生成 openapi.json 只是第一步;要看到带交互界面的漂亮文档,还得把 Swagger UI 静态资源放到 public/ 下,并配好入口 HTML。

最简做法(无需 Node.js):

  • 下载 swagger-ui-dist 的最新版 ZIP(如 v5.17.14),解压后把 dist/ 里所有文件放进 public/swagger/
  • 新建 public/swagger/index.html,内容只需改一行 URL:
<script>
  window.onload = function() {
    const ui = SwaggerUIBundle({
      url: "/openapi.json", // 指向你生成的 JSON
      dom_id: '#swagger-ui',
    });
  };
</script>

然后访问 http://your-domain.com/swagger/ 即可。别漏掉这步——光有 JSON,没有 UI,就不算“漂亮文档”。

容易被忽略的关键点:

  • openapi.json 文件权限必须是 Web 服务器可读(常见坑:生成时用 root,Nginx 无法读取)
  • 如果用了子目录部署(如 http://a.com/api/),url 和注解里的 path 都得带前缀,否则请求会发到根路径
  • 生产环境建议关闭 JSON 文件的直接访问,只通过 Swagger UI 加载,避免暴露接口细节

热门AI工具

更多
WorkBuddy

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

Atoms
Atoms Hot

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

DeepSeek

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

UP简历
UP简历 Hot

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

切问学术

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

LibLibAI
LibLibAI Hot

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

SkildArt
SkildArt Hot

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

豆包大模型

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

相关专题

更多
AI视频生成软件推荐
AI视频生成软件推荐

本专题汇总了当前主流的AI视频生成软件推荐与排行榜单,涵盖seko、AniShort、剧云、Lovart、LiblibAI及立刻mv等热门工具。同时整理了各软件在文生视频、图生视频、时长限制、画质表现及免费额度等方面的差异对比,助您快速选对适合创作需求的AI视频生成工具。

140

2026.09.16

ai生成视频的工具免费版合集
ai生成视频的工具免费版合集

本专题汇总了当前免费AI生成视频工具的排行榜与推荐清单,涵盖seko、讯飞智作、AniShort及剧云、Lovart等多模型集成平台。同时整理了各工具的免费额度、输出时长、水印政策及适用场景差异,助您快速选择合适工具开启AI视频创作。

60

2026.09.16

Pandas时间序列分析与可视化报表
Pandas时间序列分析与可视化报表

本专题整理Pandas日期转换、时间索引、重采样、滚动窗口、时区处理、plot绘图、Styler表格样式和报表输出方法。

60

2026.09.16

Pandas数据筛选索引与清洗处理
Pandas数据筛选索引与清洗处理

本专题整理Pandas中的loc、iloc、条件筛选、query查询、缺失值处理、重复值删除、类型转换和字符串列清洗方法。

40

2026.09.16

Pandas数据读取导入与文件导出处理
Pandas数据读取导入与文件导出处理

本专题整理Pandas读取CSV、Excel、JSON、SQL、Parquet等文件的方法,以及to_csv、to_excel、to_sql和to_parquet等常用数据导出流程。

40

2026.09.16

GDB怎么设置断点
GDB怎么设置断点

本专题介绍GDB按照函数名、源代码行号和文件位置设置断点的方法,详细说明run、continue、next、step等命令的配合使用,帮助定位程序崩溃、逻辑异常及代码未按预期执行的问题。

360

2026.09.11

GDB怎么查看变量值
GDB怎么查看变量值

本专题介绍GDB调试过程中查看变量值的具体方法,涵盖局部变量、函数参数、数组、结构体和指针内容查询,同时整理变量持续显示、格式化输出及无法读取变量时的排查思路。

120

2026.09.11

GDB C++程序怎么调试
GDB C++程序怎么调试

本专题围绕GDB调试C++程序的实际过程,详细说明程序编译、调试器启动、命令行参数传入、断点命中和程序继续运行等步骤,并介绍条件断点、临时断点和观察点的设置方法,方便开发者跟踪复杂代码的执行状态。

120

2026.09.11

Iris框架MVC架构与依赖注入合集
Iris框架MVC架构与依赖注入合集

本专题讲解Iris框架MVC开发模式,包含控制器注册、方法命名与路径映射、By参数绑定、BeforeActivation自定义路由,以及依赖注入容器注册、数据库依赖注入、返回值序列化及MVC下WebSocket与gRPC整合实践。

80

2026.09.11

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
LiblibAI API 工作流手册
LiblibAI API 工作流手册

共0课时 | 0人学习

GenerateAPI使用指南
GenerateAPI使用指南

共0课时 | 0人学习

apipost极速入门
apipost极速入门

共6课时 | 0.6万人学习

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

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