Documentation

Everything you need to build with Mockline.

🚧

Documentation is under construction

Full docs are coming soon. In the meantime, check out the GitHub repo or the Contour CLI docs.

Getting Started

What is Mockline?

An overview of the platform and what it does.

Quick Start

Upload or design your first spec and provision a mock server in under a minute.

Authentication

Specs & Versions

Upload OpenAPI 3.0 YAML or JSON specs. Each upload creates a new version.

Mock Servers

Isolated Docker containers running your spec via the Contour engine.

Contract Testing

Validate that a running mock server matches its OpenAPI spec.

Schema Diff

Compare two versions of the same spec to see what changed.

Specs API

CRUD operations for managing OpenAPI specifications.

Mocks API

Provision, start, stop, and remove mock server containers.

Contracts API

Run contract tests and retrieve results.

Installation

Install the Contour CLI globally via npm or pnpm.

contour start

Start a local mock server from an OpenAPI spec file.

Configuration

Port, host, stateful mode, delay, and error rate options.

Need help?

Open an issue on GitHub or email support@mockline.xyz.