SuperAPI AI 工具集

improve-sdk-naming

通用与其它

查看项目

更新于 10-16 08:11

技能介绍

用途:该技能面向使用 Speakeasy 生成 SDK 的场景,借助 AI 建议优化 SDK 方法与错误类型命名,而非手动创建 overlay。

主要能力:可运行 speakeasy suggest operation-ids -s <spec-path> 获取更优的 operation ID(SDK 方法名)建议,speakeasy suggest error-types -s <spec-path> 获取错误类型定义建议。加 -o 可将建议保存为 overlay YAML 文件,例如 speakeasy suggest operation-ids -s <spec-path> -o suggested-overlay.yaml。

命名约定:Speakeasy 依据 operation ID 生成分组方法,格式为 {group}_{method},下划线前的部分作为命名空间(x-speakeasy-group),方法名用 x-speakeasy-name-override。如 users_list 生成 sdk.users.list()。

使用方式:先认证,交互式运行 speakeasy auth login,非交互环境设置 export SPEAKSEASY_API_KEY="<your-api-key>"(原文如此,注意正确变量名为 SPEAKEASY_API_KEY)。获取建议后,将 overlay 加入 workflow.yaml 的 overlays 列表,再运行 speakeasy run --output console 重新生成 SDK。

限制与注意:不要直接修改外部管理的源规范中的 operationId,应使用 overlay;不要使用无分组的通用名称;创建 overlay 后必须加入 workflow.yaml,否则名称不会改变;不同分组间不得重复 operation 名。常见问题包括未授权(缺 API key)、重新生成后名称未变(overlay 未加入 workflow)、无建议(命名已足够好)、方法名重复、大规范超时。手动 overlay 创建不属于本技能。