Installation guide
Use the OpenAPI specification
Describe HTQLDB's API to your tools from one contract.
The OpenAPI specification is published with a release; its availability is to be confirmed.
Get the specification
Download the OpenAPI specification published with your release.
Item Description Endpoints Every documented resource and operation. Schemas The request and response structures. Security The authentication each operation requires. Import it into your tools
Load it into your HTTP client, API gateway or test suite.
Item Description HTTP clients Browse and try the documented operations. Gateways Validate requests against the contract. Tests Check responses against the documented schemas. Generate a client
Generate a typed client in your language from the same specification, or use a language SDK.
Item Description Generator Any OpenAPI-compatible client generator. Credentials Supplied at runtime, never built into the client. Keep it current
Each release publishes its specification; the changelog says what changed.
Item Description Versions Match the specification to the release you call. Changes Review the changelog before you upgrade.