api-development
使用Hono + Zod OpenAPI支持API端点创建:(1)添加新API端点、(2)创建路由定义、(3)定义响应模式、(4)创建实体模式。触发条件:「创建API」、「添加端点」、「添加路由」、「GET/POST/PUT/DELETE API」、「定义模式」、「定义响应类型」。
📖 中文导读:使用Hono + Zod OpenAPI支持API端点创建:(1)添加新API端点、(2)创建路由定义、(3)定义响应模式、(4)创建实体模式。触发条件:「创建API」、「添加端点」、「添加路由」、「GET/POST/PUT/DELETE API」、「定义模式」、「定义响应类型」。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: api-development description: Hono + Zod OpenAPIを使用したAPIエンドポイント作成を支援。(1)新しいAPIエンドポイント追加、(2)ルート定義作成、(3)レスポンススキーマ定義、(4)エンティティスキーマ作成で使用。トリガー:「APIを作成」「エンドポイント追加」「ルート追加」「GET/POST/PUT/DELETE API」「スキーマ定義」「レスポンス型」
API Development
Hono + Zod OpenAPI + Drizzle ORM構成。
API作成手順
shared/src/schemas/responses/にレスポンススキーマ作成backend/src/routes/にルート定義作成backend/src/index.tsにルートをマウント
命名規則
| エンドポイント | レスポンス名 |
|---|---|
GET /v1/tours |
ToursResponse |
GET /v1/tours/:id |
TourResponse |
GET /v1/destinations/:id/tours |
DestinationToursResponse |
ルート定義
import { createRoute, OpenAPIHono, z } from '@hono/zod-openapi'
import { MyResponse } from '@trippers/shared/schemas/responses'
import { db } from '@db/index'
const router = new OpenAPIHono()
const getRoute = createRoute({
method: 'get',
path: '/',
tags: ['TagName'],
summary: '概要',
responses: {
200: { description: '成功', content: { 'application/json': { schema: MyResponse } } },
500: { description: 'エラー', content: { 'application/json': { schema: z.object({ error: z.string() }) } } },
},
})
router.openapi(getRoute, async (c) => {
const data = await db.select().from(myTable)
return c.json(data, 200)
})
export { router as myRoute }
パスパラメータ・スキーマ定義の詳細: templates.md
マウント
// backend/src/index.ts
app.route('/v1/my-resource', myRoute)
チェックリスト
-
shared/src/schemas/responses/にレスポンススキーマ -
shared/src/schemas/responses/index.tsにexport追加 -
backend/src/routes/にルート定義 -
backend/src/index.tsにマウント