SA

speakeasy-api/speakeasy

Developer tools
424 stars 0 forks 品質 37 トレンド 37

Docs Quickstart   //   Join us on Slack

概要

Docs Quickstart   //   Join us on Slack

README

A Modern OpenAPI Native Toolchain

Polished and type-safe SDKs, Terraform providers and Contract Tests for your API. 10 Languages and counting.

How it works

Features

  • SDK code that looks like 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

Install Speakeasy CLI via:

  • Homebrew
  • Winget
  • Chocolatey
  • Shell Script / GitHub Actions
  • Docker

Refer to the Speakeasy CLI installation documentation for more information. CLI releases are also directly available in the repository releases.

Usage

Refer to the Speakeasy CLI Reference for usage documentation. Additionally, every CLI command and subcommand supports a --help flag for usage information.

Agent Skills

Use Speakeasy with AI coding agents via our Agent Skills package.

Installation

npx skills add speakeasy-api/agent-skills

Supported Platforms

Usage

Once installed, skills are available with the speakeasy: namespace:

/speakeasy:start-new-sdk-project     # Initialize a new SDK project
/speakeasy:validate-openapi-spec     # Validate an OpenAPI spec
/speakeasy:regenerate-sdk            # Re-run SDK generation

See the agent-skills repository for the full list of available skills.

View this README on GitHub

インストール

npx skills add speakeasy-api/agent-skills