skills.rest
speakeasy-api
speakeasy-apiOFFICIAL
Explore all skills by this author →
Website𝕏@speakeasydevGitHub

setup-sdk-testing

Automate Speakeasy SDK test setup and execution via gen.yaml and OpenAPI specs.

19|6|Updated Jan 23, 2026
Search Tags:#testing#openapi#sdk#integration-testing#contract-testing#arazzo
One-click install
npx skills add https://github.com/speakeasy-api/skills --skill setup-sdk-testing
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: setup-sdk-testing
Source: https://github.com/speakeasy-api/skills/tree/main/skills/setup-sdk-testing
Command: npx skills add https://github.com/speakeasy-api/skills --skill setup-sdk-testing

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Automates the setup and execution of Speakeasy SDK tests including contract tests, Arazzo workflows, and integration tests.

Core Features & Use Cases

  • Contract testing configuration via gen.yaml and OpenAPI specs for generated SDKs
  • Custom Arazzo workflow testing and integration testing against live APIs
  • CI-friendly test orchestration and reporting using the Speakeasy CLI

Quick Start

Ensure Speakeasy CLI is installed and authenticated, then generate and run tests:

  • Generate tests: speakeasy run --output console
  • Run tests: speakeasy test

Frequently Asked Questions about setup-sdk-testing

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up contract testing for a generated SDK using OpenAPI specs?▼

Contract testing for a generated SDK is configured via gen.yaml and OpenAPI specs to validate generated SDKs. It produces contract tests in the tests/ directory to ensure the SDK matches the API definition automatically.

What is Arazzo workflow testing and how does it validate SDKs against live APIs?▼

Arazzo workflow testing validates SDKs against live APIs by executing defined Arazzo test workflows. It uses custom Arazzo test definitions to run integration tests that verify SDK operations with real API endpoints.

Can I run Speakeasy SDK tests in a CI pipeline using the CLI?▼

Yes, you can run Speakeasy SDK tests in a CI pipeline using the Speakeasy CLI. The setup provides CI-friendly test orchestration and reporting, generating tests and outputting results directly to the console for automated validation.

Do I need the Speakeasy CLI installed to generate and run integration tests?▼

Yes, the Speakeasy CLI must be installed and authenticated to generate and run integration tests. You use the CLI to generate tests via 'speakeasy run' and execute them using the 'speakeasy test' command for SDK validation.

How does mock server generation work for SDK integration testing?▼

Mock server generation for SDK integration testing creates simulated API endpoints based on your OpenAPI specs. This allows generated tests in the tests/ directory to validate SDK behavior against controlled mock responses.

Related Skills

Explore More Software Engineering Skills→
speakeasy-apispeakeasy-api
19

generate-terraform-provider

Generate a Terraform provider from an OpenAPI spec using the Speakeasy CLI.

Official
Advanced
berea-chberea-ch

setup-sdk-testing

Set up and run contract, Arazzo, and integration tests for Speakeasy-generated SDKs.

Official
Advanced
speakeasy-apispeakeasy-api
19

generate-mcp-server

Generate an MCP server from an OpenAPI specification using Speakeasy CLI.

Official
Advanced
speakeasy-apispeakeasy-api
19

manage-openapi-overlays

Create, apply, and validate OpenAPI overlays using the speakeasy CLI.

Official
Intermediate