Documentation Generation
Generate docs from handlers
php bin/generate-docs.php --format=markdown --output=docs/api.md
php bin/generate-docs.php --format=html --output=docs/api.html
php bin/generate-docs.php --format=json --output=docs/api.json
php bin/generate-docs.php --format=openrpc --output=docs/openrpc.json
Supported formats
| Format | Description |
|---|---|
markdown | Markdown documentation (default) |
html | Styled HTML page |
json | Machine-readable JSON |
openrpc | OpenRPC 1.3.2 specification |
Doc metadata sources
Documentation is generated from:
- Handler method reflection (types, defaults, required)
- PHPDoc tags (
@param,@return,@throws,@error) - Procedure descriptor metadata
@requiresAuth/@authenticatedannotations@example-request/@example-responseannotations