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

PHP API文档自动生成工具

星萱小哥_8710

星萱小哥_8710

发布时间:2026-05-15 23:41:06

|

754人浏览过

|

来源于php中文网

原创

@OA\Get 不生效主因是扫描范围或加载上下文错误:Swagger-PHP 仅解析 Composer 自动加载的类;闭包路由、注解与方法间空行、PHP 版本/反射扩展不兼容、path 缺失开头 / 均会导致失效。

php api文档自动生成工具

Swagger-PHP 注解生成 OpenAPI 文档,但 @OA\Get 不生效?

不是注解写错了,大概率是扫描范围或加载上下文没对上。Swagger-PHP 默认只解析「能被 Composer 自动加载」的类文件,控制器方法如果没被 autoload 覆盖(比如写在非 PSR-4 规范路径、或用了动态 include),就直接跳过。

常见卡点:

  • @OA\Get 写在闭包路由里 —— Laravel 或 ThinkPHP 的闭包定义不进反射,必须移到控制器方法中
  • 注解块和方法之间有空行或其它注释 —— /** */ 必须紧贴方法声明上方,中间不能隔任何东西
  • PHP 版本低于 7.4 或反射扩展版本冲突 —— zircote/swagger-php v4 要求 phpdocumentor/reflection-docblock v5+,旧项目升级时容易漏掉
  • 路径写成 path="users" 而不是 path="/users" —— OpenAPI 规范强制要求绝对路径,漏掉开头 / 会导致 Swagger UI 拼接 base_url 失败

ApiGen 生成空白页面或报错 Class not found?

ApiGen 已停止维护(最后发布于 2019 年),它依赖老旧的 PHP 解析器,对 PHP 8+ 的联合类型、属性提升、命名空间别名等语法支持极差。你看到的「空白」或「Class not found」,往往是解析器在 AST 阶段就崩溃了,没抛出明确异常,只默默跳过文件。

替代建议:

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

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

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

下载
  • 改用 phpdocumentor/phpdocumentor(v3+),它基于现代 PHP-Parser,支持 PHP 8.2+ 和全部新语法
  • 命令行参数要显式指定编码和源码目录:phpdoc project:run -d src/ -t docs/api --encoding=utf8
  • 确保每个类/方法都有完整 @param 和 @return —— ApiGen 类似工具对缺失标签极其敏感,缺一个就可能整块不渲染

想绕过注释,靠类型声明自动生成文档?

PHP 8+ 的原生类型(string、int、User|null)和属性(#[OA\Property])确实能减少注释量,但工具链还没完全跟上。目前只有 zircote/swagger-php v4+ 支持 PHP 8 属性语法,且仅限于顶层类或方法,不能自动推导嵌套数组结构(如 array<user></user>)。

实际能省力的地方有限:

  • function getUser(int $id): User → @OA\Parameter 和 @OA\Response 仍需手动写,类型不会自动转成 schema
  • #[OA\Schema] 必须显式定义字段,不能靠 public User $user; 反射出 User 的全部属性
  • DTO 类里写了 public string $name;,仍得补 #[OA\Property(type: "string")],否则字段不出现在文档里

CI/CD 中自动生成文档并部署,关键在哪?

不是脚本能不能跑通,而是文档产物是否可复现、可验证。很多团队卡在「本地能生成,CI 里失败」,本质是环境差异没对齐。

必须检查的三件事:

  • CI 环境的 PHP 版本、扩展(特别是 mbstring、json、tokenizer)要和本地一致,php -m 对一遍
  • 生成命令必须带 --no-interaction 和明确输出路径,避免因交互式提示卡住;例如:vendor/bin/openapi --output public/openapi.json --spec-version 3.1.0 src/
  • 生成的 openapi.json 要加到 CI 后置校验:用 jq 检查是否存在 paths 字段、info.title 是否非空,防止静默生成空文件

最易忽略的是文档中引用的外部 schema(如 ref="#/components/schemas/User"),一旦 @OA\Components 定义位置不对或拼写错误,JSON 本身合法但 UI 渲染为空白 —— 这种问题只能靠人工点开生成的 JSON 文件肉眼核对。

相关文章

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

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

下载

相关标签:

php

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

热门AI工具

更多
豆包大模型

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

DeepSeek

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

讯飞智作

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

咔片AIPPT

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

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

蛙蛙写作

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

VibeKnow
VibeKnow Hot

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

WorkBuddy

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

Loomy
Loomy Hot

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

相关专题

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

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

12264

2023.09.01

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

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

7101

2023.10.11

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

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

2215

2023.10.11

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

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

4448

2023.10.23

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

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

5174

2023.10.23

html怎么上传
html怎么上传

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

4071

2023.11.03

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

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

5877

2023.11.09

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

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

4622

2023.11.13

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

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

20

2026.11.05

热门下载

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

精品课程

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

共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