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

星静吖_6743

星静吖_6743

2026-07-08

391人浏览

原创

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\Get 的 path 必须和路由注册完全一致

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、/index、api/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 是默认扫描路径,如有 model 或 service 里也写了接口定义,可追加路径: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 加载,避免暴露接口细节

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

thinkphp

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

相关专题

更多
Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

2026.11.12

140

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

100

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

80

15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

160

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

140

13

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

2026.11.06

120

10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

2026.11.05

120

12

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

2026.11.05

100

12

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

2026.11.04

120

16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程