Skip to content

API reference

The Kacky backend exposes a REST API. The OpenAPI spec is the single source of truth — the frontends generate their typed clients from it, and this page renders from the same spec, so the docs can't drift from the code.

How this spec stays current

The openapi.json beside this page is refreshed from the running backend (/openapi/v1.json) as a build step — never hand-edited. To refresh locally:

dotnet run --project src/KackyGG.Api            # serves the spec at /openapi/v1.json
curl -s http://localhost:5213/openapi/v1.json \
  -o docs-site/docs/api/openapi.json

In CI, a job runs the backend, exports the spec to this path, and then builds the site — so a deployed API page always matches the deployed backend.