Scalar Hono API Reference Plugin

This middleware provides an easy way to render a beautiful API reference based on an OpenAPI/Swagger file with Hono.

Installation

npm install @readyapi/hono-api-reference

Usage

Set up Zod OpenAPI Hono and pass the configured URL to the apiReference middleware:

import { apiReference } from '@readyapi/hono-api-reference'

app.get(
  '/reference',
  apiReference({
    spec: {
      url: '/openapi.json',
    },
  }),
)

The Hono middleware takes our universal configuration object, read more about configuration in the core package README.

Themes

The middleware comes with a custom theme for Hono. You can use one of the other predefined themes (alternate, default, moon, purple, solarized) or overwrite it with none. All themes come with a light and dark color scheme.

import { apiReference } from '@readyapi/hono-api-reference'

app.get(
  '/reference',
  apiReference({
    theme: 'purple',
    spec: {
      url: '/openapi.json',
    },
  }),
)

Custom page title

There’s one additional option to set the page title:

import { apiReference } from '@readyapi/hono-api-reference'

app.get(
  '/reference',
  apiReference({
    pageTitle: 'Hono API Reference',
    spec: {
      url: '/openapi.json',
    },
  }),
)

Custom CDN

You can use a custom CDN ，default is https://cdn.jsdelivr.net/npm/@readyapi/api-reference.

import { apiReference } from '@readyapi/nestjs-api-reference'

app.use(
  '/reference',
  apiReference({
    cdn: 'https://cdn.jsdelivr.net/npm/@readyapi/api-reference',
    spec: {
      content: OpenApiSpecification,
    },
  }),
)