Skip to content

Build APIs your users love ❤️ with Speakeasy. Polished and type-safe SDKs, terraform providers and contract tests for your API. OpenAPI native.

License

Notifications You must be signed in to change notification settings

speakeasy-api/speakeasy

Repository files navigation

Speakeasy

The platform to build, test, and distribute APIs to your users ❤️. Building really high quality APIs is hard. Speakeasy is a set of OpenAPI tools to make it easier.

Trusted By:

Generate Polished and Type-Safe Client Libraries

Use Speakeasy to generate idiomatic, type-safe SDKs your users will love. 9 Languages and counting.

How it works

Speakeasy Workflow

Features

  • SDK code that looks you wrote it. Optimised for performance, debuggability and modern idiomatics.
  • Complete Terraform Providers built on a Type-safe Go SDK.
  • Contract Test generation with a pre built mock-server (Powered by Arazzo)
  • Generate clean code-samples for syncing with API docs.
  • Make npm install your-api. Manage versioning and publishing to package managers
  • Modern OpenAPI 3.X toolchain for linting, cleaning, diff-ing and editing specs. (Powered by Overlays)

Check out the roadmap for whats coming up soon!

CLI installation

Homebrew (macOS and Linux)

brew install speakeasy-api/homebrew-tap/speakeasy

Script (macOS and Linux)

curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/install.sh | sh

Chocolatey (Windows)

choco install speakeasy

Manual installation

Download the latest release for your platform from the releases page, extract, and add the binary to your path.

Keeping up to date

The CLI will warn you if you're running an outdated version. To update the CLI run:

speakeasy update

Common CLI commands

Command Description
auth Log in & out of your organization's workspace.
quickstart Create an idiomatic client SDK or target, such as a Terraform Provider, from your API specs.
run Regenerate existing SDK/target from your API specs.
lint Validate the correctness of your API specs. speakeasy run also includes a validation step before generation.
suggest Use an LLM to autocorrect your spec validation failures.
merge Work with your existing documentation workflows by merging your API specs into a single spec.
status Review all SDK/targets in current workspace.

Community

We love chatting about OpenAPI and API Design. Come chat with us on slack.