What specific components of a spec can it suggest?

The skill currently focuses on optimizing operation IDs (method names) and creating structured error type definitions for common HTTP status codes.

Does it modify my source OpenAPI file directly?

No, it can output suggestions as an overlay file, allowing you to apply improvements through your workflow configuration without changing your original source file.

Can I use this in a CI/CD environment?

Yes, by setting the SPEAKEASY_API_KEY environment variable, you can run these AI suggestions in non-interactive pipelines and automated agents.

How does this skill improve my SDK?

It renames machine-generated operation IDs into human-readable method names and suggests standard error definitions, making the resulting SDK more intuitive and type-safe.

Speakeasy AI Suggestions

Name: Speakeasy AI Suggestions
Author: speakeasy-api

byspeakeasy-api

•

378

•

Desarrollo de API

Optimizes API specifications by suggesting intuitive operation IDs and structured error type definitions using AI.

The get-ai-suggestions skill leverages Speakeasy's AI capabilities to transform raw or auto-generated OpenAPI specifications into polished, developer-friendly SDKs. It intelligently renames clunky operation IDs into intuitive method names and analyzes API patterns to suggest comprehensive error response schemas. By generating these improvements as OpenAPI overlays, the skill allows developers to enhance their API contracts without manually editing the source file, ensuring a better developer experience and more consistent SDK generation across different languages.

Características Principales

01Overlay file generation for non-destructive API specification updates

02Intelligent renaming of auto-generated operation IDs into semantic method names

03378 GitHub stars

04Support for transforming cryptic endpoints into readable SDK methods

05Automated suggestions for structured HTTP error response schemas

06Seamless integration with Speakeasy workflows and CI/CD pipelines

Casos de Uso

01Improving the quality of legacy OpenAPI specs before generating new client libraries or Terraform providers

02Converting cryptic API endpoints into readable SDK methods like listUsers instead of get_api_v1_users

03Standardizing error handling across an API by adding consistent 4xx and 5xx response types

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add speakeasy-api/speakeasy get-ai-suggestions

For use in Claude.ai and ChatGPT

Download Skill