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

ThinkPHP如何做接口文档自动生成_ThinkPHP注释驱动文档方案【方法】

风墨君_4489

风墨君_4489

发布时间:2026-05-19 16:19:04

|

200人浏览过

|

来源于php中文网

原创

能,但需借助think-swagger等第三方扩展并严格遵循Swagger语法注释:必须用@api、@apiParam等非标准PHPDoc标签,注释位置紧邻且无空行,路由须显式绑定,嵌套字段需拆解声明。

thinkphp如何做接口文档自动生成_thinkphp注释驱动文档方案【方法】

ThinkPHP 接口文档能靠注释自动生成吗?

能,但不是开箱即用。ThinkPHP 本身不内置接口文档生成器,必须借助第三方扩展(如 think-swagger 或 think-api-doc),且严重依赖规范的 PHPDoc 注释结构。没写对注释格式,生成结果就是空或错乱。

注释怎么写才被 think-swagger 识别

它只认特定标签,@api、@param、@return 这类不是标准 PHPDoc,而是 Swagger/OpenAPI 的扩展语法,得手动加。原生 /** @param string $id */ 不起作用。

  • @api {POST} /api/user/create 创建用户 —— 必须有,定义路径和方法,缺了这行整个接口不进文档
  • @apiParam {string} username 用户名 —— 类型必须小写,String 或 INT 都会被忽略
  • @apiSuccess {object} data 返回数据结构 —— 嵌套字段要用点号: data.token、data.profile.name
  • 控制器方法必须是 public,且路由需显式绑定(不能全靠 Route::rule 自动解析)

为什么生成的文档里没有参数或返回值

常见原因是注释位置或层级不对:@apiParam 必须紧贴在 @api 下方,中间不能插空行或其它标签;@apiSuccess 同理。另外,ThinkPHP 的自动路由(比如 Route::get('user/:id', 'index/user/info'))会导致路径解析失败,think-swagger 找不到对应方法。

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

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

下载
  • 检查生成命令输出是否有 Warning: method not found for route xxx
  • 把路由改写成闭包或显式绑定控制器方法:Route::post('api/user', 'api.UserController/create')
  • 确保注释块包裹的是实际执行的 action 方法,不是父类里的同名方法
  • 如果用了中间件做参数校验(如 Validate),think-swagger 不会自动提取验证规则,得手写 @apiParam

生成后页面打不开或 JSON 报错

多数是 Swagger UI 加载的 swagger.json 格式非法,根源常在中文注释里的全角标点、未转义的斜杠、或数组描述用了中文括号。

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

  • 避免在 @apiDescription 里用「」、【】、——,统一用英文引号和破折号
  • @apiParam {array} tags 标签列表 后面不要跟 (例: ["a","b"]),这种说明会被当 JSON 解析,导致语法错误
  • 生成命令默认输出到 public/swagger.json,确认该路径 Nginx/Apache 有读取权限,且没被 rewrite 规则拦截
  • 如果用了多模块,需在配置中指定扫描目录:'scan_path' => [APP_PATH . 'api/controller/']

最麻烦的其实是嵌套响应体的类型声明——@apiSuccess {object} data.user 看似合理,但 think-swagger 不支持两级 key 的类型标注,得拆成 data 和 user 两个独立字段,否则 JSON Schema 会崩。

相关文章

驱动精灵
驱动精灵

驱动精灵基于驱动之家十余年的专业数据积累,驱动支持度高,已经为数亿用户解决了各种电脑驱动问题、系统故障,是目前有效的驱动软件,有需要的小伙伴快来保存下载体验吧!

下载

相关标签:

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

热门AI工具

更多
WorkBuddy

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

UpDream
UpDream Hot

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

LibLibAI
LibLibAI Hot

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

DeepSeek

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

豆包大模型

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

切问学术

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

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

讯飞绘文

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

二狗PPT
二狗PPT Hot

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

相关专题

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

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

9624

2023.09.01

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

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

5781

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数据库的详细内容,可以访问下面的文章。

3608

2023.10.23

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

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

4314

2023.10.23

html怎么上传
html怎么上传

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

3371

2023.11.03

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

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

4797

2023.11.09

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

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

3742

2023.11.13

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

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

0

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