A hono swagger middleware build around swagger-jsdoc
npm install hono-swagger-jsdocjavascript
import { Hono } from 'hono';
import { honoSwaggerJsdoc } from 'hono-swagger-jsdoc';
const app = new Hono();
app.get(
'/swagger.json',
honoSwaggerJsdoc({
failOnErrors: true,
definition: {
openapi: '3.0.0',
info: {
title: 'INS API v1',
version: '1.0.0',
},
},
apis: ['./src/api/routes/v1//.ts', './src/api/routes/v1//.yaml'],
})
);
`
The input to honoSwaggerJsdoc is the options for swagger-jsdoc. You can learn more about these options here.
honoSwaggerUI
This middleware returns the HTML for the Swagger UI. It requires the locations of all the Swagger specification files, which can be generated and served by the honoSwaggerJsdoc middleware.
`javascript
import { Hono } from 'hono';
import { honoSwaggerUI } from 'hono-swagger-jsdoc';
const app = new Hono();
app.get(
'/api-docs',
honoSwaggerUI({
urls: [{ url: '/v1/swagger.json', name: 'v1' }],
})
)
``