Guides

Guides

Step-by-step guides, best practices, and tutorials for the Speakeasy API Platform.

Guide categories

OpenAPI Guides

Learn how to work with OpenAPI specs

SDK Guides

Best practices for SDK generation and maintenance

SDK Overlays

Customize and modify OpenAPI specs with overlays

Hook Guides

Extend SDK functionality with hooks

Terraform Guides

Generate Terraform providers from OpenAPI specs

OpenAPI guides

Additional properties

How Speakeasy SDKs handle additionalProperties

Code Samples Extension

Sync SDK usage snippets with your documentation

Path Fragments

Solve equivalent path signatures

SDK guides

Create a Monorepo

Create a monorepo with Speakeasy and GitHub

User Agent Strings

Gather telemetry from SDK interactions

Generate in a Subdirectory

Setup your SDK in a subdirectory

TypeScript Monorepo Tips

Best practices for TypeScript SDKs in monorepos

Using PNPM

Configure pnpm as your default package manager

Override Compile Commands

Streamline SDK generation process

Publish Specs to API Registry

Manage OpenAPI specs with Speakeasy

SDK overlays

Common Overlays for SDKs

Learn how to implement changes with overlays

Internal and External SDKs

Create different SDK versions with overlays

JSON Path Expressions

Target and modify parts of OpenAPI specs

Hook guides

Environment Auth Hook

Authenticate with local environment variables

PostHog Telemetry Hook

Track events with PostHog and SDK hooks

Sentry Error Hook

Capture errors with Sentry and SDK hooks

User Agent Hook

Set user agents in browser environments

Terraform guides

CRUD Example

Annotate operations for CRUD functionalities

Hoisting

Flatten API requests/responses for better alignment

Merged Entity

Create entities from multiple API calls

Remove Non-TF Endpoints

Filter endpoints with overlays

Async Provisioning

Wait for create and delete with polling overlays