用途:在不修改源 OpenAPI 规范的情况下,通过 overlay 文件定制 SDK 生成,并修复校验问题。适用场景包括用户提出“创建 overlay”“应用 overlay”“overlay 语法”“JSONPath 定位”“校验 overlay”等请求。不适用于 AI 驱动的命名建议(应使用 improve-sdk-naming)。
主要能力:创建、应用、校验 overlay;通过对比两个规范生成 overlay;通过 overlay 添加 x-speakeasy 扩展,如方法命名与分组(x-speakeasy-name-override、x-speakeasy-group)、重试(x-speakeasy-retries)、分页(x-speakeasy-pagination)、允许未知枚举值(x-speakeasy-unknown-values)、全局参数(x-speakeasy-globals)、自定义安全方案(x-speakeasy-custom-security-scheme)。
使用方式:先设置 SPEAKEASY_API_KEY 环境变量或运行 speakeasy auth login。对比生成:speakeasy overlay compare -b <before-spec> -a <after-spec> -o <output-overlay>。应用:speakeasy overlay apply -s <spec-path> -o <overlay-path> --out <output-path>。校验:speakeasy overlay validate -o <overlay-path>。推荐将 overlay 加入 .speakeasy/workflow.yaml 的 sources.overlays,按顺序应用,后覆盖前。改动后需运行 speakeasy run --output console 重新生成 SDK 才生效。
限制:不能用于修复无效 YAML/JSON 语法、错误的 $ref 路径、数据类型错误或需要结构分析的 schema 去重;这些问题须修改源规范。不存在 speakeasy overlay create 命令。目标未命中需检查 JSONPath 大小写与路径。