SuperAPI AI 工具集

manage-openapi-overlays

编程与开发

查看项目

更新于 10-16 04:33

技能介绍

用途:Overlay 可在不修改源 OpenAPI 规范的情况下定制 SDK 生成。该技能覆盖创建 overlay 文件、将其应用到规范、以及用其修复校验错误。

主要能力:支持手动创建 overlay(含 JSONPath 目标)、应用现有 overlay、校验 overlay 语法与结构、比较两个规范生成 overlay,并通过 x-speakeasy-* 扩展定制 SDK 的命名、分组、重试、分页、全局参数与安全方案。还可用于修复 lint 问题(如操作名差、缺描述、缺标签、需分组、需重试配置、弃用端点、加 SDK 元数据等)。不适合 AI 命名建议(应改用 improve-sdk-naming)。

使用方式:需先配置认证,设置 SPEAKEASY_API_KEY 环境变量或运行 speakeasy auth login。 生成 overlay:speakeasy overlay compare -b <before-spec> -a <after-spec> -o <output-overlay> 应用 overlay:speakeasy overlay apply -s <spec-path> -o <overlay-path> --out <output-path> 校验 overlay:speakeasy overlay validate -o <overlay-path> 推荐将 overlay 加入 .speakeasy/workflow.yaml 的 sources.overlays 下,按顺序应用,后者可覆盖前者。修改后需重新生成 SDK:speakeasy run --output console。

适用场景:外部管理的规范无法直接编辑时,用 overlay 修正校验问题、配置 SDK 命名、分组、重试、分页、开放枚举、全局头与自定义安全方案。

限制:不用于修复非法 YAML/JSON 语法、损坏的 $ref、错误数据类型或去重 schema——这些需修改源规范。不存在 speakeasy overlay create 命令。overlay 更改仅在重新生成 SDK 后生效。具体收费、价格与平台信息暂未提供。