/** @jsxImportSource https://esm.sh/hono@3.9.2/jsx **/ import { swaggerUI } from "npm:@hono/swagger-ui"; import { z } from "npm:@hono/zod-openapi"; import { OpenAPIHono } from "npm:@hono/zod-openapi"; import { createRoute } from "npm:@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"); const route = createRoute({ method: "get", path: "/users/{id}", request: { params: ParamsSchema, }, responses: { 200: { content: { "application/json": { schema: UserSchema, }, }, description: "Retrieve the user", }, }, }); const app = new OpenAPIHono(); app.get("/", c => c.html( <>

Hono Zod Example

OpenAPI Spec
Swagger UI
Example API call:{" "} GET /users/123

, )); app.openapi(route, (c) => { const { id } = c.req.valid("param"); return c.json({ id, age: 20, name: "Ultra-man", }); }); app.doc("/openapi.json", { openapi: "3.0.0", info: { version: "1.0.0", title: "My API", }, }); app.get("/swagger", swaggerUI({ url: "/openapi.json" })); export default app.fetch;

honoZodSwaggerUi