This middleware provides an easy way to render a beautiful API reference based on an OpenAPI/Swagger file with Hono.
npm install @scalar/hono-api-referenceSet up Zod OpenAPI Hono and pass the configured URL to the apiReference middleware:
import { apiReference } from '@scalar/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.
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 '@scalar/hono-api-reference'
app.get(
'/reference',
apiReference({
theme: 'purple',
spec: {
url: '/openapi.json',
},
}),
)There’s one additional option to set the page title:
import { apiReference } from '@scalar/hono-api-reference'
app.get(
'/reference',
apiReference({
pageTitle: 'Hono API Reference',
spec: {
url: '/openapi.json',
},
}),
)You can use a custom CDN ，default is https://cdn.jsdelivr.net/npm/@scalar/api-reference.
import { apiReference } from '@scalar/nestjs-api-reference'
app.use(
'/reference',
apiReference({
cdn: 'https://cdn.jsdelivr.net/npm/@scalar/api-reference',
spec: {
content: OpenApiSpecification,
},
}),
)