Do I need an API key to use this?

Yes, you need a Speakeasy API key set as an environment variable or via 'speakeasy auth login' for the AI suggestions to work.

How does this skill improve my SDK?

It uses AI to analyze your OpenAPI spec and suggests more readable names for your methods and errors, converting names like 'get_v1_users' to 'listUsers'.

Does this modify my original OpenAPI specification?

No, it generates an overlay file that applies naming overrides externally, keeping your source spec untouched while improving the generated SDK.

What commands does this skill use?

It primarily uses 'speakeasy suggest operation-ids' and 'speakeasy suggest error-types' to generate naming recommendations.

Speakeasy SDK Naming Optimizer

Name: Speakeasy SDK Naming Optimizer
Author: speakeasy-api

byspeakeasy-api

•

API開発

Optimizes SDK method naming and error types using AI-powered suggestions and Speakeasy CLI commands to improve developer experience.

This skill leverages Speakeasy's AI capabilities to transform generic or auto-generated OpenAPI operation IDs into intuitive, human-readable SDK method names. It allows developers to preview improvements, generate overlay files to maintain source spec integrity, and suggest structured error types, ensuring that generated SDKs provide a premium developer experience with clean naming conventions like sdk.users.list() instead of getApiV1Users. By automating the identification of naming patterns and error structures, it streamlines the process of refining API client libraries without requiring manual edits to the core specification.

主な機能

01Automatic error type definition recommendations for better error handling

02AI-powered operation ID suggestions for cleaner method names

03Support for x-speakeasy-group and name-override extensions

04CLI integration for previewing and applying naming improvements

05Generation of non-destructive OpenAPI overlays for spec enhancement

065 GitHub stars

ユースケース

01Refactoring ugly auto-generated SDK method names into semantic actions

02Standardizing error handling across an entire API surface via AI analysis

03Automating naming overlays for large, complex OpenAPI specifications

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add speakeasy-api/skills improve-sdk-naming

For use in Claude.ai and ChatGPT

Download Skill