菜单
Contract-driven API development using OpenAPI with Hono and Zod. Use when working with OpenAPI specs, contract-first development, generating API documentation, or writing route handlers with @hono/zod-openapi.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | openapi-cdd |
| description | Contract-driven API development using OpenAPI with Hono and Zod. Use when working with OpenAPI specs, contract-first development, generating API documentation, or writing route handlers with @hono/zod-openapi. |
Core principle: Define the contract first, then implement. The OpenAPI spec is the source of truth.
Your project uses:
@hono/zod-openapi for type-safe route handlersSee schema-patterns.md for Zod schema conventions.
Before writing code:
Run npm run export:spec to export the OpenAPI spec, then regenerate client types if needed.
Use @hono/zod-openapi handlers:
import { OpenAPIHono, createRoute } from '@hono/zod-openapi'
const app = new OpenAPIHono()
const getUserRoute = createRoute({
method: 'get',
path: '/users/{id}',
tags: ['Users'],
summary: 'Get user by ID',
description: 'Retrieves a user by their unique identifier',
request: {
params: z.object({
id: z.string().openapi({ param: { in: 'path' }, example: 'usr_123' })
})
},
responses: {
200: {
description: 'User found',
content: {
'application/json': {
schema: UserSchema,
example: { id: 'usr_123', email: 'user@example.com', name: 'John' }
}
}
},
404: ErrorResponse
}
})
app.openapi(getUserRoute, async (c) => {
const { id } = c.req.valid('param')
const user = await getUserById(id)
if (!user) return c.json({ error: 'Not found' }, 404)
return c.json(user)
})
app.doc('/openapi.json', {
openapi: '3.0.0',
info: { title: 'My API', version: '1.0.0' }
})
npm run export:spec produces valid OpenAPI/docsSee schema-patterns.md for:
Automate API endpoint testing against running dev server. Starts server if needed, runs all endpoints, reports failures, writes bug plans to docs/. Use when testing API endpoints, running smoke tests, or validating API contract compliance.
Project rules for building features - branch strategy, architecture compliance, testing, and commit workflow. Use when starting a new feature, enhancement, or bug fix, or when asked about development workflow.
Authentication token flows - JWT access/refresh tokens, verification tokens, password reset tokens, and token blacklisting. Use when implementing auth, token refresh, email verification, password reset, or logout with token invalidation.
Drizzle ORM for PostgreSQL - schema definitions, migrations, queries, and repository patterns. Use when working with database tables, migrations, writing repository layers, or running db:generate/migrate commands.