API Documentation

Distinguish QQQ middleware endpoints from your application API and its OpenAPI contract.

Two API surfaces

QQQ middleware serves the admin application's metadata, records, and process interactions. Application APIs use the API backend/middleware modules and explicit API metadata for versioning, exposed tables, fields, routes, and authentication.

A table in QInstance does not by itself establish a public /api/v1 contract. Base paths, auth requirements, HTTP methods, pagination, and response shapes depend on the registered API and middleware version.

Use the deployed specification

Inspect the OpenAPI specification registered by your running application. Use its documented path, parameters, security scheme, and response model when writing a client. Do not assume every endpoint uses a Bearer token or a universal success/data/errors envelope.

4.0 source references

Javalin middleware: endpoint specs and executors.

Application API middleware: routes and API specification handling.

API backend module: API metadata and field/filter helpers.

The Javalin package moved to com.kingsrook.qqq.middleware.javalin in 4.0. Follow the migration guide for renamed packages and changed API helper signatures.