Hono OpenAPI

hono-openapi 是一个 中间件，通过与 Zod、Valibot、ArkType 和 TypeBox 等验证库以及所有支持 Standard Schema 的库集成，使你的 Hono API 可以自动生成 OpenAPI 文档。

🛠️ 安装

🌐 🛠️ Installation

安装该软件包以及你首选的验证库及其依赖：

🌐 Install the package along with your preferred validation library and its dependencies:

npm install hono-openapi @hono/standard-validator

在本指南中，我们将使用 valibot

🌐 In this guide, we will use valibot

npm install valibot @valibot/to-json-schema

你可以在此了解更多关于安装的信息 - https://honohub.dev/docs/openapi#installation

---

🚀 入门

🌐 🚀 Getting Started

1. 定义你的模式

🌐 1. Define Your Schemas

使用你偏好的验证库定义你的请求和响应模式。以下是使用 Valibot 的示例：

🌐 Define your request and response schemas using your preferred validation library. Here's an example using Valibot:

import * as v from 'valibot'

const querySchema = v.object({
  name: v.optional(v.string()),
})

const responseSchema = v.string()

---

2. 创建路由

🌐 2. Create Routes

使用 describeRoute 进行路由文档编制和验证：

🌐 Use describeRoute for route documentation and validation:

import { Hono } from 'hono'
import { describeRoute, resolver, validator } from 'hono-openapi'

const app = new Hono()

app.get(
  '/',
  describeRoute({
    description: 'Say hello to the user',
    responses: {
      200: {
        description: 'Successful response',
        content: {
          'text/plain': { schema: resolver(responseSchema) },
        },
      },
    },
  }),
  validator('query', querySchema),
  (c) => {
    const query = c.req.valid('query')
    return c.text(`Hello ${query?.name ?? 'Hono'}!`)
  }
)

注意：
当从 hono-openapi 使用 validator() 时，为 query、json、param 或 form 添加的任何验证都会自动包含在 OpenAPI 请求模式中。
无需在 describeRoute() 内手动定义请求参数。

---

3. 生成 OpenAPI 规范

🌐 3. Generate OpenAPI Spec

为你的 OpenAPI 文档添加一个端点：

🌐 Add an endpoint for your OpenAPI document:

import { openAPIRouteHandler } from 'hono-openapi'

app.get(
  '/openapi',
  openAPIRouteHandler(app, {
    documentation: {
      info: {
        title: 'Hono API',
        version: '1.0.0',
        description: 'Greeting API',
      },
      servers: [
        { url: 'http://localhost:3000', description: 'Local Server' },
      ],
    },
  })
)

---

想要了解更多，请查看我们的文档 - https://honohub.dev/docs/openapi