Generate SDKs from OpenAPI

Generating your first SDK with Speakeasy takes no more than a few minutes. Follow these steps to get started.

Sign up for Speakeasy

First sign up for a free Speakeasy account at https://app.speakeasy.com (opens in a new tab).

New accounts start with a 14 day free trial of Speakeasy’s business tier, to enable users to try out every SDK generation feature. At the end of the trial, accounts will revert to the free tier. No credit card is required.

Free accounts can continue to generate one SDK with up to 50 API methods free of charge.

Install the Speakeasy CLI

After signing up, install the Speakeasy CLI using one of the following methods:

# Homebrew (macOS)
brew install speakeasy-api/homebrew-tap/speakeasy

For manual installation, download the latest release from the releases page (opens in a new tab), extract the binary, and add it to the system path.

Speakeasy Quickstart

For first-time SDK generation, run speakeasy quickstart.

speakeasy quickstart

The CLI will prompt you to authenticate with your Speakeasy account. A browser window will open where you can select a workspace to associate the CLI with. You can always change workspaces later if required.

Upload an OpenAPI document

After authenticating you will be prompted to input an OpenAPI document:

Provide either a link to a remote hosted OpenAPI document, or a relative path to a local file in one of the supported formats:

TIP

If your spec is in an unsupported format, use one of the following tools to convert it:

• Swagger 2.0 -> OpenAPI 3.0 (opens in a new tab): go to Edit > Convert to OpenAPI 3.0
• Postman -> OpenAPI 3.0 (opens in a new tab)

Select an SDK language

After configuring the OpenAPI document, the next step prompt is to name your SDK. It’s best to name the SDK after the company or project it’s being used for.

Choose a name for your SDK. And pick an SDK output directory.

There will then be a language selection prompt:

For each language,Speakeasy has crafted generators with language experts to be highly idiomatic. Follow the links below for all the details on the design decisions that have gone into each language we support:

Supported generation languages

TypeScript

Fetch-based async client with Zod typing

Python

Sync & async client with Pydantic models

Go

Type-safe, idiomatic Go client

Java

Type-safe, builder-based Java client

C#

Type-safe, .NET-based C# client

PHP

Type-safe, Laravel-integrated client

Ruby [alpha]

A type-safe Ruby client

Unity [beta]

Unity-integrated C# client

Complete the SDK configuration

The final steps are to configure a package name for the SDK package and pick an SDK output directory. The package name will only be relevant, when it comes time to publish the package. The CLI will infer a name from the OpenAPI document, which can be optionally overwritten.

Then you specify the output directory for the generated SDK.

Speakeasy validates the specifications and generates the SDK after receiving all inputs. The process executes speakeasy run to validate, generate, compile, and set up the SDK. A confirmation message displays the generated SDK details upon successful completion:

Iterating on the SDK

If the SDK is successfully generated, there will be a prompt asking the user to open the SDK studio. The Studio is a web GUI that helps users make look & feel improvements to their SDKs. It uses OpenAPI Overlays to preserve the original OpenAPI specification while allowing users to make changes to the generated SDK.

Saved changes in the Studio automatically triggers a regeneration of the SDK locally.

It is also posisble to make changes without the Studio. Check out the following guide on customizing your SDKs for all the details.

Next Step: Uploading your SDK to GitHub

Once the SDK is looking good, you can upload it to GitHub. Follow the Github setup guide