Slide 17
Slide 17 text
● @hono/zod-openapiでAPIを開発
● Zodを使用して値と型を検証
● APIファイルに直接API仕様を記述可
● /doc 下で OpenAPI Swaggerの
API仕様書が利用可
import { OpenAPIHono, createRoute } from '@hono/zod-openapi';
const route = createRoute({
method: 'get',
path: '/path',
description: 'This is a sample API',
request: {
params: ParamsSchema, // Zod Schema
},
responses: {
200: {
content: {
'application/json': {
schema: UserSchema, // Zod Schema
},
},
description: '200 OK',
},
},
});
const app = new OpenAPIHono();
app.openapi(route, (c) => {
// API logic should be here
});
app.doc('/doc', {
openapi: '3.0.0',
info: {
version: '1.0.0',
title: 'Sample API',
},
});
参考: API開発とAPI仕様書の生成①
17