Installation guide

Use the OpenAPI specification

Describe HTQLDB's API to your tools from one contract.

View API reference

The OpenAPI specification is published with a release; its availability is to be confirmed.

  1. Get the specification

    Download the OpenAPI specification published with your release.

    ItemDescription
    EndpointsEvery documented resource and operation.
    SchemasThe request and response structures.
    SecurityThe authentication each operation requires.
  2. Import it into your tools

    Load it into your HTTP client, API gateway or test suite.

    ItemDescription
    HTTP clientsBrowse and try the documented operations.
    GatewaysValidate requests against the contract.
    TestsCheck responses against the documented schemas.
  3. Generate a client

    Generate a typed client in your language from the same specification, or use a language SDK.

    ItemDescription
    GeneratorAny OpenAPI-compatible client generator.
    CredentialsSupplied at runtime, never built into the client.
  4. Keep it current

    Each release publishes its specification; the changelog says what changed.

    ItemDescription
    VersionsMatch the specification to the release you call.
    ChangesReview the changelog before you upgrade.