Skip to content

Legacy OpenAPI viewer ​

Purpose and current behavior ​

services/openapi is a small standalone Go HTTP server retained for compatibility. It reads a pre-generated YAML specification, serves it at /openapi.yaml, and serves its embedded Scalar HTML from the root handler. Its default address is :8081; its default specification path is relative to the module directory.

sh
go run ./services/openapi -spec api/openapi.yaml

This viewer does not build the project documentation or provide the welcome page and Swagger route. make serve-docs serves the full Caddy site instead. The old viewer uses an unpinned Scalar CDN script; the Caddy viewer retains its pinned script. Prefer the full docs image for a reproducible documentation deployment.

The module does not own business data, database migrations, authentication, or specification generation. Its existing manifest uses the historical prescripto import prefix; documentation discovery uses each package's actual import path rather than assuming every module has the same prefix. See code reference.

Documentation follows the source. Planned contracts are marked explicitly.