SuperAPI AI 工具集

openapi-pro

编程与开发

查看项目

更新于 10-16 04:30

技能介绍

用途:openapi-pro 是面向 API 架构与集成工程的技能,专注类型安全的 API 契约设计,连接 Hono 后端与 Next.js 16 前端,实现 monorepo 内统一类型共享。

主要能力:支持契约优先(OpenAPI YAML → 代码)与代码优先(Zod/Hono → OpenAPI YAML)两种策略;审计规范完整性(安全方案、错误响应、示例);用 zod-to-openapi 或 @hono/zod-openapi 从 Zod 派生规范;用 openapi-fetch、orval 生成类型安全客户端;采用 OpenAPI 3.1 以获得 JSON Schema 2020-12 兼容性。

使用方式:按顺序激活技能 activate_skill(name="openapi-pro") → activate_skill(name="prisma-expert") → activate_skill(name="next16-expert");用 bun x openapi-typescript 或 orval 验证生成类型与最新 schema 一致;将 Zod schema 集中到共享包(如 @repo/api-contract);在 CI 中检查生成客户端与规范同步。

适用场景:需要类型安全 API 契约、自动生成客户端、前后端类型共享的 TypeScript 项目。

限制与规范:不要手写 OpenAPI YAML(使用 TypeScript 时);避免通用 axios/fetch 封装;schema 中必须定义 4xx/5xx 错误;不要手动编辑生成文件;不要硬编码 base URL;不要混用 camelCase 与 snake_case;发布前用 redocly lint 校验。具体收费、价格与平台支持暂未提供。