PHPv1.0.6
PHP 使用指南
在 Laravel、ThinkPHP、Hyperf、Webman、Yii2、Yii3 中写 PHP 8 attributes，自动生成可浏览、可调试、可导出的接口文档。
- 安装与框架接入
- 注解、参数与响应规则
- definitions / ref / children 复用
- 鉴权、导出、场景与排错
API 文档使用指南
四种实现，一套文档工作流。选择语言，从安装、规则到场景与排错。
Gov1.0.7
Go 使用指南
接口文档以类型化结构体随路由注册，内嵌 Web UI 提供浏览与在线调试；兼容 net/http、Gin、Echo、Chi、Fiber、beego、Kratos、go-zero。
- 安装、Config 与 Router
- Route / Doc / Param / Response
- 8 个框架适配器
- 鉴权、缓存、导出、场景与排错
Rustv2.0.0
Rust 使用指南
用过程宏在 handler 上声明文档，编译期静态注册，运行期零成本聚合；兼容 axum 与 actix-web，内置鉴权、Mock、导出、分享与代码生成。
- 依赖、宏与编译期规则
- axum / actix-web 接入
- 鉴权、Mock、多应用版本
- 导出、代码生成、场景与排错
UIVue 3.5
apidoc-ui 使用指南
Vue 3 + TypeScript 的文档加载与展示页面，支持应用/版本、在线调试、接口分享、Swagger 导出、缓存管理与多语言。构建产物为纯静态文件。
- 构建与部署
- config.js 运行时配置
- 多 Host / appKey / 鉴权
- 调试事件、Mock 扩展与排错
从声明到交付，五步。
无论使用哪种语言，文档都沿着同一条路径进入生产。
1声明
2浏览
3调试
4导出
5部署
核心概念对照
同一件事在不同语言里的实现方式。
| 概念 | PHP | Go | Rust |
|---|---|---|---|
| 声明方式 | PHP 8 attributes | 类型化 Doc 结构体 | 过程宏属性 |
| 文档生成时机 | 运行时解析控制器 | 路由注册时写入 | 编译期静态注册 |
| 框架适配 | 6 个 | 8 个 | axum / actix-web |
| 在线调试 / Mock | 支持 / 规则表达式 | 支持 / 按类型生成 | 支持 / 15 条 fake 规则 |
| 鉴权 | 全局与应用密码 | Cookie session + 应用 token | HMAC-SHA256 token |
| 导出 | JSON / TS / Swagger / 分享 | JSON / TS | Markdown / TS / Swagger / 分享 |
常见问题
关于 Apidoc 的常见疑问。
Apidoc 是什么？
Apidoc 是一套 PHP、Go、Rust 通用的 API 文档体系：在代码旁声明文档，自动生成可浏览、可调试、可导出的接口文档，并共用同一个静态文档 UI。
支持哪些框架？
PHP 支持 Laravel、ThinkPHP、Hyperf、Webman、Yii2、Yii3；Go 支持 net/http、Gin、Echo、Chi、Fiber、beego、Kratos、go-zero；Rust 支持 axum 与 actix-web。
需要数据库或额外后端吗？
Apidoc 本身不要求额外数据库；文档由各语言实现随应用生成，apidoc-ui 构建产物是纯静态文件，可直接部署。
如何开始？
选择 PHP、Go、Rust 或 apidoc-ui 指南，从安装与最小示例开始；每篇指南都包含框架接入、注解规则、典型场景与排错。