Four implementations, one documentation workflow. Choose a language and go from install to rules, scenarios and troubleshooting.
Write PHP 8 attributes in Laravel, ThinkPHP, Hyperf, Webman, Yii2 or Yii3 and get a browsable, debuggable, exportable API portal.
Declare docs as typed structs next to route registration. A built-in web UI provides browsing and live debugging for net/http, Gin, Echo, Chi, Fiber, beego, Kratos and go-zero.
Declare docs with proc macros on handlers, register them statically at compile time and aggregate at zero runtime cost. Works with axum and actix-web, with auth, Mock, exports, sharing and codegen built in.
A Vue 3 + TypeScript documentation front-end with apps/versions, live debugging, sharing, Swagger export, cache management and i18n. The build output is fully static.
Whichever language you use, docs follow the same path into production.
How the same job is implemented in each language.
| Concept | PHP | Go | Rust |
|---|---|---|---|
| Declaration | PHP 8 attributes | Typed Doc structs | Attribute macros |
| Docs built at | Runtime controller scan | Route registration | Compile time, static registry |
| Framework adapters | 6 | 8 | axum / actix-web |
| Debug / Mock | Yes / rule expressions | Yes / generated by type | Yes / 15 fake rules |
| Auth | Global and app passwords | Cookie session + app token | HMAC-SHA256 token |
| Exports | JSON / TS / Swagger / share | JSON / TS | Markdown / TS / Swagger / share |
Common questions about Apidoc.
Apidoc is a shared API documentation system for PHP, Go and Rust. Declare docs next to your code and get browsable, debuggable and exportable API docs with one static documentation UI.
PHP: Laravel, ThinkPHP, Hyperf, Webman, Yii2 and Yii3. Go: net/http, Gin, Echo, Chi, Fiber, beego, Kratos and go-zero. Rust: axum and actix-web.
Apidoc does not require an extra database. Docs are generated alongside your application, and the apidoc-ui build output is fully static and can be deployed as-is.
Pick the PHP, Go, Rust or apidoc-ui guide and start from the install and minimal example. Each guide covers framework setup, annotation rules, common scenarios and troubleshooting.
