5fd80263f2
Closes https://github.com/honojs/hono/issues/1415 * chore(swagger-editor): 🔨 init * ci: 🎡 swagger editor workflow create workflow for swagger-editor package * docs: 📝 readme have writed documentation * test(test): ✅ create test for swagger-editor middleware * fix(swagger-editor): 🐛 fixed cdn url in html content * chore: 🔨 v0.1.0 release * format * fix the typos * remove unnecessary `.` * remove unnecessay `vite` and fix the `vitest.config.ts` * fix the relase workflow * update the changeset and `package.json` --------- Co-authored-by: Yusuke Wada <yusuke@kamawada.com> |
||
|---|---|---|
| .. | ||
| src | ||
| test | ||
| README.md | ||
| package.json | ||
| tsconfig.json | ||
| vitest.config.ts | ||
README.md
Swagger Editor Middleware for Hono
This library, @hono/swagger-editor is the middleware for integrating Swagger Editor with Hono applications. The Swagger Editor is an open source editor to design, define and document RESTful APIs in the Swagger Specification.
Installation
npm install @hono/swagger-editor
# or
yarn add @hono/swagger-editor
Usage
You can use the swaggerEditor middleware to serve Swagger Editor on a specific route in your Hono application. Here's how you can do it:
import { Hono } from 'hono'
import { swaggerUI } from '@hono/swagger-ui'
const app = new Hono()
// Use the middleware to serve Swagger Editor at /swagger-editor
app.get('/swagger-editor', swaggerEditor({ url: '/doc' }))
export default app
Options
Middleware supports almost all swagger-editor options. See full documentation: https://swagger.io/docs/open-source-tools/swagger-editor/
Authors
- Ogabek Yuldoshev https://github.com/OgabekYuldoshev
License
MIT