API Docs Plugin

The API Docs Plugin generates OpenAPI JSON from an artifact and serves it together with Swagger UI. The artifact can be a direct object or an application context key. When used with RPC Plugin, it defaults to the context key 'rpc.artifact', so you can register it with no options.

Installation

npm install @honestjs/api-docs-plugin
# or
yarn add @honestjs/api-docs-plugin
# or
pnpm add @honestjs/api-docs-plugin

Basic Setup

Using artifact from RPC Plugin

The RPC plugin writes its artifact to the application context. API Docs defaults to the context key 'rpc.artifact', so you can omit options when using both plugins. Ensure RPC runs before ApiDocs in the plugins array:

import { Application } from "honestjs";
import { RPCPlugin } from "@honestjs/rpc-plugin";
import { ApiDocsPlugin } from "@honestjs/api-docs-plugin";
import AppModule from "./app.module";

const { hono } = await Application.create(AppModule, {
	plugins: [new RPCPlugin(), new ApiDocsPlugin()],
});

export default hono;

If RPC uses custom context.namespace or context.keys.artifact, pass the resulting full key to artifact (e.g. new ApiDocsPlugin({ artifact: 'custom.artifact' })).

By default:

• OpenAPI JSON: /openapi.json
• Swagger UI: /docs

Using a direct artifact

You can pass the artifact object directly instead of a context key:

import { ApiDocsPlugin } from "@honestjs/api-docs-plugin";

const artifact = {
	routes: [
		{
			method: "GET",
			handler: "list",
			controller: "UsersController",
			fullPath: "/users",
			parameters: [],
		},
	],
	schemas: [],
};

// In Application.create options:
plugins: [new ApiDocsPlugin({ artifact })];

Configuration Options

interface ApiDocsPluginOptions {
	// Optional: artifact - direct object or context key. Default: 'rpc.artifact'
	artifact?: OpenApiArtifactInput | string;

	// OpenAPI metadata (when converting artifact to spec)
	title?: string;
	version?: string;
	description?: string;
	servers?: readonly { url: string; description?: string }[];

	// Serving
	openApiRoute?: string; // default: '/openapi.json'
	uiRoute?: string; // default: '/docs'
	uiTitle?: string; // default: 'API Docs'
	reloadOnRequest?: boolean; // default: false
}

Option	Description
artifact	Context key string or direct { routes, schemas } object. Default: 'rpc.artifact'.
title, version, description, servers	OpenAPI document metadata.
openApiRoute	Path where the OpenAPI JSON is served. Default: '/openapi.json'.
uiRoute	Path where Swagger UI is served. Default: '/docs'.
uiTitle	Title shown in the Swagger UI page. Default: 'API Docs'.
reloadOnRequest	If true, the spec is regenerated on each request; otherwise it is cached. Default: false.

Custom OpenAPI metadata

new ApiDocsPlugin({
	title: "My API",
	version: "1.0.0",
	description: "REST API for the application.",
	servers: [{ url: "https://api.example.com", description: "Production" }],
	openApiRoute: "/api-spec.json",
	uiRoute: "/api-docs",
	uiTitle: "My API Docs",
});

Programmatic API

For custom workflows (e.g. writing the spec to a file), use the exported utilities:

import {
	fromArtifactSync,
	write,
	type OpenApiArtifactInput,
	type OpenApiDocument,
} from '@honestjs/api-docs-plugin'

const artifact: OpenApiArtifactInput = { routes: [...], schemas: [...] }
const spec: OpenApiDocument = fromArtifactSync(artifact, {
	title: 'My API',
	version: '1.0.0',
})
await write(spec, './generated/openapi.json')

Integration with RPC Plugin

See RPC Plugin - Application Context Artifact for how the RPC plugin publishes its artifact. API Docs defaults to reading 'rpc.artifact', so with both plugins you can use new ApiDocsPlugin(); pass artifact only if RPC uses a custom context key.