@questpie/openapi

@questpie/openapi

Auto-generate an OpenAPI 3.1 spec from a QUESTPIE app instance and serve interactive API docs via Scalar UI.

Installation

bun add @questpie/openapi

Usage

Register openApiModule in your modules.ts file to add /openapi.json and /docs routes:

// src/questpie/server/modules.ts
import { adminModule } from "@questpie/admin/modules/admin";
import { openApiModule } from "@questpie/openapi/modules/openapi";

export default [adminModule, openApiModule] as const;

Configure the OpenAPI module via config/openapi.ts:

// src/questpie/server/config/openapi.ts
import { openApiConfig } from "@questpie/openapi/server";

export default openApiConfig({
	info: { title: "My API", version: "1.0.0" },
	scalar: { theme: "purple" },
});

Your route handler stays clean — no wrapper needed:

// routes/api/$.ts
import { createFetchHandler } from "questpie/http";
import { app } from "#questpie";

const handler = createFetchHandler(app, { basePath: "/api" });

Once registered, the following endpoints are available:

GET /api/openapi.json → OpenAPI spec
GET /api/docs         → Scalar UI

What Gets Documented

Routes with an explicit outputSchema get full request/response documentation. Routes without it fall back to { type: "object" }.

Standalone Spec Generation

Generate the spec without mounting routes:

import { generateOpenApiSpec } from "@questpie/openapi/server";

const spec = generateOpenApiSpec(app, {
	basePath: "/api",
	info: { title: "My API", version: "1.0.0" },
});

Documentation

Full documentation: https://questpie.com/docs/client/openapi

License

MIT