// Documentation

Build with REST Test.

Practical product documentation for the connected workflow from API definition to tested request and generated integration code.

Getting started

Create a workspace, add an API source and move from an operation to your first request.

Import an OpenAPI or Swagger JSON file, or connect a JSON or YAML URL source.

Create and edit operations, request schemas, responses, examples and mock variants.

Browse normalized definitions, operations and schemas inside an authenticated workspace.

Build requests from scratch or from documented operations and choose the right execution runner.

Generate operation-focused TypeScript, C# and Python integration code from normalized schemas.

Define response variants and execute them through the authenticated cloud mock runtime.

Organize API work, invite members and control destructive actions with roles.

Understand Cloud Runner, Browser Runner, CORS and safe request handling.

Read the canonical workspace API and invoke generation or cloud mocks through the stable v1 contract.

Create purpose-specific integration keys and send them safely.

Generate files through the same backend type generator used by the REST Test web application.

Generate SDK source files through the existing REST Test SDK registry.

Execute enabled operation mocks by method and normalized path with workspace API-key authentication.

Initialize a local project, generate files, and compare local revision state with the workspace API.

Configure generators, output directories, config discovery, and revision locking.

Run generation and revision checks non-interactively with environment credentials.

Download the saved workspace definition as validated OpenAPI JSON and resolve export errors.

Connect a repository specification, review source changes and troubleshoot synchronization.

// GET STARTED

Start with an OpenAPI or Swagger JSON definition and keep the workflow together.