Apidoc / PHP · Go · Rust
Declare docs next to your handlers and get a browsable, debuggable, exportable API portal. PHP, Go and Rust share one document model and one static UI.
Apidoc turns API docs from hand-written Markdown into declarations next to your code. PHP uses PHP 8 attributes, Go uses typed structs, and Rust uses proc macros. All three share one document model, live debugging and the same static front-end.
The PHP edition started from HGthecode/apidoc-php (hg/apidoc). Go, Rust and apidoc-ui are maintained by erikwang2013. Each language keeps its native setup while the documentation experience stays consistent.
From declaration to delivery, all three languages follow the same documentation pipeline.
One documentation workflow, different declaration mechanisms, framework adapters and build times. Every language has its own guide.
Attribute-driven API docs for PHP 8
Write PHP 8 attributes in Laravel, ThinkPHP, Hyperf, Webman, Yii2 or Yii3 and get a browsable, debuggable, exportable API portal.
composer require erikwang2013/apidoc-phpTyped docs registered with routes
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.
go get github.com/erikwang2013/apidoc-goProc-macro docs generated at compile time
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.
apidoc-rust = "2.0"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.
One static front-end for all three backends · Vue 3.5 · Vite 6 · Pinia · Monaco
npm ci && npm run build
Keep your stack. Declare routes and docs in the language you already use; Apidoc handles generation, debugging and delivery.
use erikwang2013\apidoc\annotation as Apidoc;
#[Apidoc\Title("Get user")]
#[Apidoc\Method("GET")]
#[Apidoc\Url("/users/{id}")]
#[Apidoc\RouteParam(
name: "id", type: "int"
)]
#[Apidoc\Returned(
name: "name", type: "string"
)]
public function show(int $id) { }
s.Register(apidoc.Route{
Method: "GET",
URL: "/users/:id",
Handler: getUser,
Doc: apidoc.Doc{
Title: "Get user",
Params: []apidoc.Param{
{Name: "id", In: "path",
Type: "int", Required: true},
},
Responses: []apidoc.Response{
{Name: "name", Type: "string"},
},
},
})
#[apidoc::title("Get user")]
#[apidoc::method("GET")]
#[apidoc::url("/users/{id}")]
#[apidoc::route_param(
name = "id", ty = "int", required
)]
#[apidoc::returned(
name = "name", ty = "string"
)]
async fn get_user() {}
Live debug, auth, exports and the shared UI follow one workflow; see each guide for exact capabilities.
Call real endpoints from the docs page with global params, Mock prefill and request/response events. Every language guide includes a debug panel.
Field-level Mock examples. PHP supports rule expressions, Go generates values by type, and Rust ships 15 fake rules.
nickname"erik"email"fake:email"id1024Manage multiple apps and versions in one portal, switch by the app tree, and scope access passwords per app.
Global and per-app passwords, document caching, ETag/304 and constant-time comparison for speed with a security boundary.
password******JSON, TypeScript, Markdown and Swagger/OpenAPI are available per language. Hand request and response shapes to front-end and QA.
PHP and Rust provide template-driven code generation; Go focuses on exports and comment parsing.
apidoc-ui serves PHP, Go and Rust backends. Vue 3 + TypeScript with a fully static build.
apidoc-ui · Vue 3HMAC tokens, CORS allowlists and path/identifier validation. Treat the docs server like a production API.
HMAC-SHA256CORSDeclare, browse, debug, export and deploy on one path, shared by all three languages.
annotations next to code
docs generated automatically
live requests and Mock
JSON / TS / Swagger
Each guide covers installation, rules, complete examples, common scenarios and troubleshooting. Pick your stack, then go deep.
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.
6 for PHP, 8 for Go and 2 for Rust. One document model, thin native adapters.
The minimum install command for each stack. Framework setup, config and complete examples live in the guides.
composer require erikwang2013/apidoc-phpgo get github.com/erikwang2013/apidoc-goapidoc-rust = "2.0"npm ci && npm run buildEvery guide starts from a minimal runnable example, then covers annotation rules, scenarios and troubleshooting.
Full changelogs and release assets live on each repository's Releases page.
It is a walking documentation page. Every expression is a standalone SVG with its own motion, honoring prefers-reduced-motion.
:emoji-smile:
:emoji-joy:
:emoji-cry:
:emoji-depressed:
:emoji-terrified:
:emoji-angry:
:emoji-coquettish:
:emoji-cute:
:emoji-pleasing::emoji-knocking:
:emoji-facepalm:
:emoji-tongue:The project pet and expressions are visual assets owned by the author. Commercial use requires permission. See ASSETS-LICENSE.md. ASSETS-LICENSE.md.
Get it from Packagist, Go modules, crates.io or GitHub. All three backends share one documentation UI.