SuperAPI AI 工具集

improve-sdk-naming

编程与开发

查看项目

更新于 10-16 01:25

技能介绍

用途:改进 SDK 方法与错误类型的命名。它既支持 Speakeasy 的 AI 建议,也支持手动命名覆盖,但本技能聚焦于 speakeasy suggest 命令的自动建议;手动创建 overlay 请改用 manage-openapi-overlays。

主要能力:当 SDK 方法出现 GetApiV1Users 这类自动生成名称时,可让 Speakeasy AI 建议更好的 operationId,或建议错误类型定义。触发词包括 suggest improvements、speakeasy suggest、AI suggestions、suggest operation-ids、suggest error-types、get AI recommendations。

输入:OpenAPI spec 路径(-s,必填);认证(必填,通过 speakeasy auth login 或 SPEAKEASY_API_KEY 环境变量);输出文件路径(-o,选填)。输出:打印到控制台的更好 operation 名称或错误类型,以及可选的 overlay YAML 文件。

必要用法:非交互环境(CI/CD、AI 智能体)先设置 export SPEAKEASY_API_KEY="<your-api-key>",交互使用则运行 speakeasy auth login。建议 operationId:speakeasy suggest operation-ids -s <spec-path>;建议错误类型:speakeasy suggest error-types -s <spec-path>;输出为 overlay:speakeasy suggest operation-ids -s <spec-path> -o suggested-overlay.yaml。不带 -o 可预览将要发生的更改。生成 overlay 后需将其加入 workflow.yaml 的 overlays 列表,再运行 speakeasy run --output console 重新生成 SDK,否则名称不会改变。

命名约定:operation ID 采用 {group}_{method},如 users_list、users_get、users_create、users_update、users_delete,分别对应 sdk.users.list()、get()、create()、update()、delete()。x-speakeasy-group 定义命名空间,x-speakeasy-name-override 定义方法名。

限制与注意:外部管理的 spec 不要直接修改 operationIds,应使用 overlay;不要使用没有分组的 get、post 等通用名;每个 {group}_{method} 组合必须唯一。排错:unauthorized 表示 API 密钥缺失或无效;重新生成后名称未变通常是 overlay 未加入 workflow;无建议返回说明命名已良好;方法名重复需为各端点设置唯一的 x-speakeasy-name-override;spec 过大导致超时可缩小范围或增加超时。