Package Exports

wiremock-rest-client

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (wiremock-rest-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

WireMock REST Client

The WireMock REST client is a lightweight module to interact with a running WireMock server based on the OpenAPI 3.0 spec via REST.

Installation
Usage
API
Logging

Installation

npm install wiremock-rest-client

Usage

The WireMockRestClient has 5 services which correspond with request paths as specified in the OpenAPI spec.

global - Global operations
mappings - Operations on stub mappings
recordings - Stub mapping record and snapshot functions
requests - Logged requests and responses received
scenarios - Scenarios support modeling of stateful behavior

See the API for the available methods. All methods are related to available operations on the WireMock server endpoints.

import { WireMockRestClient } from 'wiremock-rest-client';

const wireMock = new WireMockRestClient('http://localhost:8080');

const stubMappings = await wireMock.mappings.getAllMappings();

console.log(stubMappings);

await wireMock.global.shutdown();

API

Global

updateGlobalSettings(delayDefinition: DelayDefinition): Promise<void>
resetAll(): Promise<void>
shutdown(): Promise<void>

Example:

await wireMockRestClient.global.resetAll();

Stub mappings

getAllMappings(): Promise<StubMappings>
createMapping(stubMapping: StubMapping): Promise<StubMapping>
createMappingFromFile(fileName: string): Promise<StubMapping>
createMappingsFromDir(directoryName: string): Promise<any>
deleteAllMappings(): Promise<void>
resetAllMappings(): Promise<void>
getMapping(uuid: string): Promise<StubMapping>
updateMapping(uuid: string, stubMapping: StubMapping): Promise<StubMapping>
deleteMapping(uuid: string): Promise<void>
saveAllMappings(): Promise<void>
findByMetaData(contentPattern: ContentPattern): Promise<StubMappings>
removeByMetaData(contentPattern: ContentPattern): Promise<void>

Example:

await wireMockRestClient.mappings.resetAllMappings();

const stubMapping = {
    "request": {
        "method": "GET",
        "urlPathPattern": "/api/helloworld"
    },
    "response": {
        "status": 200,
        "jsonBody": {"hello": "world"},
        "headers": {
            "Content-Type": "application/json"
        }
    }
};

const response = await wireMock.mappings.createMapping(stubMapping);

// Create mapping from current working directory
await wireMock.mappings.createMappingFromFile('stubs/hello-world.json');

// Create mappings from a directory recursively (based on current working directory)
await wireMock.mappings.createMappingsFromDir('stubs');

Recordings

startRecording(recordSpec: RecordSpec): Promise<void>
stopRecording(): Promise<StubMappings>
getRecordingStatus(): Promise<any>
takeSnapshotRecording(snapshotSpec: RecordSpec): Promise<StubMappings>

Example:

const recordingStatus = wireMockRestClient.recordings.getRecordingStatus();

Requests

getAllRequests(): Promise<any>
deleteAllRequests(): Promise<void>
getRequest(uuid: string): Promise<any>
deleteRequest(uuid: string): Promise<void>
resetAllRequests(): Promise<void>
getCount(requestPattern: RequestPattern): Promise<any>
removeRequests(requestPattern: RequestPattern): Promise<any>
removeRequestsByMetadata(contentPattern: ContentPattern): Promise<any>
findRequests(requestPattern: RequestPattern): Promise<any>
getUnmatchedRequests(): Promise<any>
getUnmatchedNearMisses(): Promise<LoggedRequest[]>
getNearMissesByRequest(loggedRequest: LoggedRequest): Promise<any>
getNearMissesByRequestPattern(requestPattern: RequestPattern): Promise<any>

Example:

const requests = await wireMockRestClient.requests.getAllRequests();

Scenarios

getAllScenarios(): Promise<Scenario[]>
resetAllScenarios(): Promise<void>

Example:

await wireMockRestClient.scenarios.resetAllScenarios();

Logging

Default log level is info
Each log line contains a unique id to trace logs for a single request
Log level debug will log the request body for each request.

A different log level can be configured by setting the environment variable WRC_LOG_LEVEL to specific a log level (trace/debug/info/warn/error/silent)

Example:

[10f7dcb9-b8a3-4598-8751-40edb0bd5d2e] [INFO] Request: [POST] http://localhost:8080/__admin/mappings
[10f7dcb9-b8a3-4598-8751-40edb0bd5d2e] [DEBUG] Request body:  {"request":{"method":"GET","urlPathPattern":"/api/helloworld"},"response":{"status":200,"jsonBody":{"hello":"world"},"headers":{"Content-Type":"application/json"}}}
[10f7dcb9-b8a3-4598-8751-40edb0bd5d2e] [INFO] Response: [201] Created
[c3690603-c055-4412-a5b0-497704c09dd0] [INFO] Request: [POST] http://localhost:8080/__admin/shutdown
[c3690603-c055-4412-a5b0-497704c09dd0] [INFO] Response: [200] OK