OpenAPI

This docs site includes a local OpenAPI spec at:

txt
./openapi.json

The live API exposes the generated spec at:

txt
https://api.rogeriq.com/api/v1/openapi.json

The live endpoint is protected by API-key middleware, so the docs site uses the local spec for rendering and interactive examples.

Validate the Spec

bash
npx @holydocs/cli openapi-check docs-site/openapi.json

Generate Reference Pages

bash
npx @holydocs/cli generate docs-site/openapi.json --dir docs-site --output api-reference

Use with Codegen

bash
npx openapi-typescript docs-site/openapi.json -o rogeriq-api.d.ts

Server

The OpenAPI spec uses:

txt
https://api.rogeriq.com

Paths include the full /api/v1 or /api prefix so public API and public form endpoints can be described in one spec.

Ask a question... ⌘I