sdk-tf-generation-best-practices

Comprehensive best-practices reference for generating SDKs and Terraform providers with Speakeasy. Covers the full lifecycle: OpenAPI spec preparation, code-first extraction, generation workflows, language-specific guides, customization, and testing.

When to Use

• Generating an SDK from an OpenAPI spec
• Generating a Terraform provider from an OpenAPI spec
• Generating an MCP server from an OpenAPI spec
• Extracting an OpenAPI spec from existing code (FastAPI, Flask, Django, Spring Boot, NestJS, Hono, Rails, Laravel)
• Customizing SDK generation (hooks, auth, error handling, retries, pagination)
• Fixing OpenAPI validation errors or applying overlays
• Testing generated SDKs (integration, contract, Arazzo)
• Understanding language-specific SDK patterns (TypeScript, Python, Go, Java, C#, Ruby, PHP)
• User says: "generate SDK", "SDK best practices", "terraform provider", "generate MCP server", "SDK customization", "SDK testing"

How to Use

This skill contains detailed guides in the content/ subdirectory relative to this file. Read the specific guide for the user's task rather than trying to answer from this index alone.

To find the right guide, use the routing table below or the decision tree.

Quick Routing Table

What are you trying to do?

Directory Structure

content/
├── INDEX.md                    # This index (SKILL.md)
├── plans/                      # Decision trees for workflows
│   ├── sdk-generation.md       # Full SDK generation workflow
│   └── tf-provider-generation.md
├── 

...