# hono-swagger-jsdoc

> A hono swagger middleware build around swagger-jsdoc

Latest version **0.0.6** (published 2023-08-08) · ISC license · 0 weekly downloads

## Install

```sh
npm install hono-swagger-jsdoc
pnpm add hono-swagger-jsdoc
yarn add hono-swagger-jsdoc
bun add hono-swagger-jsdoc
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2023-08-08 |
| First published | 2023-08-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 9.3 KB |
| Known vulnerabilities | 0 (+38 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | vlaem |

## Links

- npm: https://www.npmjs.com/package/hono-swagger-jsdoc
- Repository: https://github.com/vlaem/hono-swagger-json
- Homepage: https://github.com/vlaem/hono-swagger-json#readme
- Issues: https://github.com/vlaem/hono-swagger-json/issues
- npm.io page: https://npm.io/package/hono-swagger-jsdoc

## Dependencies (3)

- [hono](https://npm.io/package/hono.md) ^3.3.4
- [swagger-jsdoc](https://npm.io/package/swagger-jsdoc.md) ^6.2.8
- [@types/swagger-jsdoc](https://npm.io/package/@types/swagger-jsdoc.md) ^6.0.1

## Recent versions

- 0.0.6 (latest) — 2023-08-08
- 0.0.5 — 2023-08-04
- 0.0.3 — 2023-08-04
- 0.0.2 — 2023-08-04
- 0.0.1 — 2023-08-04

## README

# hono-swagger-jsdoc

hono-swagger-jsdoc is a Swagger generator for [Hono](https://hono.dev). It exposes two functions that act as middleware for your Hono application:

    honoSwaggerJsdoc
    honoSwaggerUI

## honoSwaggerJsdoc

This middleware generates and returns the swagger.json file. It is a wrapper around swagger-jsdoc, and accepts the same options.

```javascript
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](https://github.com/Surnet/swagger-jsdoc#readme).

## 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' }],
  })
)
```
## FAQ

**Why are the two middleware separate? Should we just use a single middleware to generate both the spec and the UI?**

The two middleware are kept separate to allow for the setup of multiple Swagger JSON files. For instance, if you have multiple versions of your API available (e.g., /api/v1, /api/v2), coding them into a single middleware would be more difficult.

---
_Source: https://npm.io/package/hono-swagger-jsdoc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._