phpdoc注释是文档生成前提,需在类、方法、参数前规范添加@param、@return、@api等标签;支持laravel、thinkphp等框架路由自动识别,可输出openapi 3.0、html、markdown格式文档,并可通过cli或ci/cd自动同步。

PHP代码注释驱动文档生成
工具核心依赖PHPDoc标准注释,需在类、方法、参数前添加规范注释。例如使用@param说明参数类型与含义,@return标注返回值,@api或@endpoint标识接口入口。不写注释则无法提取接口信息,生成文档将为空或缺失关键字段。
支持主流PHP框架结构识别
自动适配Laravel、ThinkPHP、CodeIgniter等常见框架的路由定义方式。对Laravel可扫描routes/api.php及控制器中@Route注解;对ThinkPHP识别route/route.php和控制器方法上的@method与@url。若使用自定义路由注册方式,需通过配置文件指定扫描路径与解析规则。
输出多格式API文档
- 生成标准OpenAPI 3.0(yaml/json)文件,可直接导入Postman或Swagger UI
- 导出静态HTML文档,含请求示例、响应结构、状态码说明
- 支持Markdown输出,便于嵌入项目README或GitBook等知识库
命令行一键触发与CI/CD集成
安装后执行php artisan doc:generate(Laravel)或php docgen --src=app/ --output=docs/openapi.yaml即可运行。支持在GitHub Actions、GitLab CI中配置为推送代码后的自动任务,确保文档与代码始终同步。建议将生成结果提交至docs/目录并启用GitHub Pages托管HTML版。
大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!











