@luckystack/docs-ui
v0.16.1
Published
Dev-only API docs UI for LuckyStack. Mounts a Swagger-style page at /_docs that reads `apiDocs.generated.json` and renders every API route, its inputs/outputs, auth, and rate-limit metadata.
Maintainers
Readme
@luckystack/docs-ui
A development UI for generated LuckyStack API documentation. In a scaffolded project use npx luckystack add docs-ui, or install @luckystack/docs-ui and mount its handler through the server's custom routes. Generate API artifacts with the project's generateArtifacts script if the UI reports that they are missing. See mounting for the access boundary.
Do not expose the documentation route publicly by accident. Production access is disabled by default; if you intentionally enable it, add authorization and review generated metadata for sensitive detail. The optional interactive request runner uses the browser's credentials and should only be enabled for trusted developers. Custom HTML templates must escape content from generated metadata; see HTML generation.
