OpenAPI

LittleDemo publishes an OpenAPI 3.1 spec:

text
https://littledemo.com/openapi.json

HolyDocs uses that spec to generate the endpoint reference in this docs site.

Validate the spec locally

bash
npx @holydocs/cli openapi-check https://littledemo.com/openapi.json

Use it for clients

You can feed the spec into your preferred OpenAPI generator.

bash
npx openapi-typescript https://littledemo.com/openapi.json -o littledemo-api.d.ts

Hand-written pages vs generated pages

The generated reference is the source for exact request and response shapes. The hand-written API pages explain how endpoints fit together in real workflows.

Ask a question... ⌘I