Claude Code OpenAPI 转 TypeScript 技能|校验可选与可空字段
EnglishClaude Code 安装步骤
- 从固定版本 GitHub 工作副本获取完整的 `cli-tool/components/skills/development/openapi-to-typescript` 目录。
- 将目录放入目标项目的 `.claude/skills/`,确认 `.claude/skills/openapi-to-typescript/SKILL.md` 存在,再从项目根目录启动 Claude Code 并输入 `/openapi-to-typescript`。
中文摘要
根据 OpenAPI 3.0 定义生成 TypeScript 类型并处理 `$ref`,用输入样本核对字段是否可省略或可为 null。
SKILL.md 中文导读
可复现示例
把书目 schema 转为类型。`title` 是必填字符串,`subtitle` 是可选且允许为 null。测试省略 `subtitle`、传入 null 和省略 `title`。工作步骤
- 读取 `components.schemas`、`required`、`nullable` 和引用的定义,为各字段保留原始语义。
- 生成接口与必要的运行时校验。用成功和失败样本分别检查缺失字段、空值与类型不匹配。
验收方法
应接受前两种有效样本,并拒绝缺少 `title` 的对象。类型和运行时检查应与 schema 一致。
GitHub 原文 · 更新日期
适用环境
准备 OpenAPI 3.0 YAML 或 JSON 文档,以及现有 TypeScript 项目的检查方式。
常见问题
可选字段和允许 null 是一回事吗?
可选意味着可以省略键。允许 null 指键存在时可接受 null 值。两种条件可以同时成立。