Zod OpenAPI

Zod OpenAPI Hono ist eine erweiterte Hono-Klasse mit Unterstützung für OpenAPI. Damit kannst du Werte und Typen mit Zod validieren und OpenAPI-Swagger-Dokumentation erzeugen. Auf dieser Website wird nur die grundlegende Verwendung gezeigt.

Definiere zuerst deine Schemas mit Zod. Das Objekt z sollte aus @hono/zod-openapi importiert werden:

import { z } from '@hono/zod-openapi'

const ParamsSchema = z.object({
  id: z
    .string()
    .min(3)
    .openapi({
      param: {
        name: 'id',
        in: 'path',
      },
      example: '1212121',
    }),
})

const UserSchema = z
  .object({
    id: z.string().openapi({
      example: '123',
    }),
    name: z.string().openapi({
      example: 'John Doe',
    }),
    age: z.number().openapi({
      example: 42,
    }),
  })
  .openapi('User')

Erstelle anschließend eine Route:

import { createRoute } from '@hono/zod-openapi'

const route = createRoute({
  method: 'get',
  path: '/users/{id}',
  request: {
    params: ParamsSchema,
  },
  responses: {
    200: {
      content: {
        'application/json': {
          schema: UserSchema,
        },
      },
      description: 'Retrieve the user',
    },
  },
})

Richte zum Schluss die Anwendung ein:

import { OpenAPIHono } from '@hono/zod-openapi'

const app = new OpenAPIHono()

app.openapi(route, (c) => {
  const { id } = c.req.valid('param')
  return c.json({
    id,
    age: 20,
    name: 'Ultra-man',
  })
})

// The OpenAPI documentation will be available at /doc
app.doc('/doc', {
  openapi: '3.0.0',
  info: {
    version: '1.0.0',
    title: 'My API',
  },
})

Du kannst deine Anwendung wie eine normale Hono-Anwendung starten. Verwende für Cloudflare Workers und Bun diesen Einstiegspunkt:

export default app

Siehe auch

• Zod OpenAPI Hono