Skip to main content

OpenAPI

Konifer serves API documentation from the running service. Open http://localhost:8080/api/docs in your browser to use Swagger UI, or download the generated specification at /api/docs/openapi.json.

MethodPathResponse
GET/api/docsSwagger UI (HTML)
GET/api/docs/openapi.jsonOpenAPI specification (JSON)

These routes require no request body or configuration flag. Konifer registers them at startup.

Download the specification​

curl --fail-with-body \
  --output openapi.json \
  'http://localhost:8080/api/docs/openapi.json'

Use this JSON document in an OpenAPI viewer or tooling that imports API specifications. Download it from the Konifer instance you use so the document reflects that server's implementation.

Asset operations​

The specification represents asset routes as /assets/{**}. Replace ** with your asset path and selectors, such as users/123/profile-picture/-/content. See the Fetch Assets reference for selector examples.

The specification also describes the K-Attr-* headers on content and download responses, including dimensions, remaining display orientation, and pixel attributes. See Content attribute headers for their values and optional fields.