Slack community

Blog

WireMock Cloud

API Reference

Login

Get Support

Stop recording

Absent matcher

Before datetime

Logical AND matcher

A base64 encoded string used to describe binary data.

Base64 string

Binary equals

String contains

Content pattern

The delay distribution. Valid property configuration is either median/sigma/type or lower/type/upper.

Log normal randomly distributed response delay.

Log normal

Uniformly distributed random response delay.

Uniform

Fixed

String does not contain

Negative regular expression match

JSON equals

String equals

XML equality

Has exactly multi value matcher

JSONPath match

JSON Schema match

Regular expression match

XPath match

NOT modifier

Pre-emptive basic auth credentials to match against

Request body patterns to match against in the <key>: { "<predicate>": "<value>" } form

Cookie patterns to match against in the <key>: { "<predicate>": "<value>" } form

The matcher's name specified in the implementation of the matcher.

application/x-www-form-urlencoded form parameter patterns to match against in the <key>: { "<predicate>": "<value>" } form

Header patterns to match against in the <key>: { "<predicate>": "<value>" } form

Multipart patterns to match against headers and body.

Path parameter patterns to match against in the <key>: { "<predicate>": "<value>" } form. Can only
be used when the urlPathPattern URL match type is in use and all keys must be present as variables
in the path template.


Query parameter patterns to match against in the <key>: { "<predicate>": "<value>" } form

The scheme (protocol) part of the request URL

The path and query to match exactly against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.

The path to match exactly against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.

The path regex to match against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.

The path and query regex to match against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.

Extra request headers to send when proxying to another host.

The response body as a string. Only one of body, base64Body, jsonBody or bodyFileName may be specified.

The path to the file containing the response body, relative to the configured file root. Only one of body, base64Body, jsonBody or bodyFileName may be specified.

The parameters for chunked dribble delay - chopping the response into pieces and sending them at delayed intervals

The fault to apply (instead of a full, valid response).

Number of milliseconds to delay be before sending the response.

Read-only flag indicating false if this was the default, unmatched response. Not present otherwise.

The response body as a JSON object. Only one of body, base64Body, jsonBody or bodyFileName may be specified.

The base URL of the target to proxy matching requests to.

A path segment to remove from the beginning in incoming request URL paths before proxying to the target.

Request headers to remove when proxying to another host.

Parameters to apply to response transformers.

List of names of transformers to apply to this response.

The new state for the scenario to be updated to after this stub is served.

Indicates that the stub mapping should be persisted immediately on create/update/delete and survive resets to default.

A map of the names of post serve action extensions to trigger and their parameters.

This stub mapping's priority relative to others. 1 is highest.

The required state of the scenario in order for this stub to be matched.

The name of the scenario that this stub mapping is part of

basicAuth

Overview

Overview of mock APIs with WireMock Cloud

Overview of WireMock Cloud's stubbing capabilities

Stubbing Overview

Stubbing Basics

Advanced request matching, bodyPatterns matching and response definition

Advanced Stubbing

Triggering asynchronous outbound HTTP calls

Webhooks and Callbacks

Chaos Testing

Chaos settings - Basics

Serving default responses when no specific match is found

Default Responses

Serving a Default Response

Response Delays

Proxying Requests

Proxying

Creating new stubs by recording traffic to another API

Recording Stubs

Simulating Faults

Matching SOAP requests and sending SOAP responses

Working with SOAP

Configuring your own rate limiters in order to simulate the real thing.

Configuring Rate Limits

User Configurable Rate Limits

Overview of the OpenAPI mock API type and two-way mock generation

Working With OpenAPI

OpenAPI Mocking and Prototyping

Generate your mock API automatically from a Swagger or OpenAPI definition.

Import OpenAPI

Import & Export - Swagger and OpenAPI

Integrating your Git repository with your mock API

Syncing With Git

OpenAPI Git Integration

Validating mock API requests and responses against OpenAPI

OpenAPI Validation

Overview of the match operations supported by WireMock Cloud

Matcher Types

Request Matching - Overview of Matcher Types

Matching JSON

Request Matching - Matching JSON requests

Request Matching - Matching URLs

Matching XML

Request Matching - Matching XML bodies

Return different responses based on a state machine

Simple Scenarios

Simple state with scenarios

Advanced Dynamic State

Dynamic State Basics

A workable example of using dynamic state to mock CRUD operations on a shopping basket

Shopping Cart Example

Dynamic State Shopping Basket Example

Plan Limits

Dynamic State - Plan Limits

Data Sources Overview

Data Sources - Using External Test Data

Managing Data Sources

Data Sources - Setting up your external test data

Sharing your data source with other members within your organisation.

Sharing Data Sources

Data Sources - Plan Limits

Returning dynamic responses using Handlebars templates

Basics

Response Templating - Basics

Working with if statements, loops and collections.

Conditional Logic

Response Templating - Conditional Logic and Iteration

Date And Times

Response Templating - Dates and Times

JSON And JSONPath

Response Templating - Working with JSON

JWT Web Tokens

Response Templating - JSON Web Tokens (JWT)

Miscellaneous Helpers

Response Templating - Miscellaneous Helpers

Number Helpers

Response Templating - Number Helpers

Generate Test Data

Response Templating - Random Faker

Generate Random Values

Response Templating - Random Values

Working with base64, URL and form encodings.

String Encodings

Response Templating - String Encodings

String Helpers

Response Templating - String Helpers

Response Templating - Working with XML

Importing and exporting mock APIs between WireMock and WireMock Cloud.

Importing via WireMock OSS

Import & Export - WireMock

Importing Postman collections into WireMock Cloud.

Importing via Postman

Import & Export - Postman

Automating import and export of mock API stubs via WireMock Cloud's API.

Importing via API

Import & Export - Via the API

Importing Via HAR

WireMock Cloud's API security and how to work with it

API Security Overview

Security

Working with teams & sharing Mock APIs in WireMock Cloud

Teams and Collaboration

OAuth2 and OIDC

The OAuth2 / OpenID Connect Mock

Key Management

Key management

Get data about your organisation's use of the product

Product Usage Data

Getting and updating your organisation information, and managing members

Organisation Info and Members

Creating, fetching and deleting teams and team members via the API

Managing Teams and Members

Getting and updating user account information

User Info

Creating, updating, deleting and permissioning mock APIs via the API.

Mock APIs

Exploratory testing a Spring Boot app with WireMock Cloud

Exploratory Testing With Spring Boot

Creating automated tests in Java and WireMock Cloud

Automated Testing With Java

Automated Testing with Java

How to build an online mock REST API in WireMock Cloud for functional, integration and performance testing

Users

Mock APIs

Teams

Organisations

Security

Data sources

Database connections

Usage

Access control

Stub Mappings

Requests

Recordings

State

OpenAPI

Stop recording

Authorizations

Path Parameters

Response