WireMock CLI local service configuration

WireMock CLI and Runner local service config file format

Type object
File match wiremock.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/wiremock-cli-local-service-configuration/latest.json
Source https://static.wiremock.io/schemas/wiremock.yaml-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Configuration file for WireMock CLI local services (wiremock.yaml)

Properties

services Record<string, object> required

Map of service names to their configurations

global object

Global configuration settings that apply to all services

1 nested properties
https object

Global HTTPS settings

1 nested properties
certificate pem-file | keystore

Full certificate configuration (PEM or keystore)

Definitions

local-service object

Configuration for a single local mock service

type string required

The type of mock API. Case insensitive.

Values: "REST" "Unstructured" "gRPC" "GraphQL"
name string required

Human-readable name for the service

description string

Optional description of the service

cloud_id string

WireMock Cloud mock API ID for syncing with cloud

pattern=^[a-z0-9]{4,15}$
port integer

TCP port number

min=1max=65535
path string

Path to the directory containing stub mappings, files, and API specifications (relative to wiremock.yaml)

open_api object

OpenAPI validation configuration

1 nested properties
validation_mode string required

OpenAPI validation mode

Default: "none"
Values: "none" "soft" "hard"
https object

HTTPS configuration for the service

2 nested properties
port integer required

TCP port number

min=1max=65535
certificate pem-file | keystore | only-alias

Partial certificate configuration (can reference global certificate by alias)

originals Record<string, string>

Map of original request/response templates

open-api-config object

OpenAPI validation configuration

validation_mode string required

OpenAPI validation mode

Default: "none"
Values: "none" "soft" "hard"
full-certificate pem-file | keystore

Full certificate configuration (PEM or keystore)

partial-certificate pem-file | keystore | only-alias

Partial certificate configuration (can reference global certificate by alias)

pem-file object

PEM-encoded certificate and private key

pem string required

Path (absolute or relative to wiremock.yaml) to a file containing a private key and certificate in PEM encoding

keystore object

PKCS12 or JKS keystore configuration

keystore string required

Path (absolute or relative to wiremock.yaml) to a PKCS12 or JKS keystore

password string required

Password to unlock the keystore

alias string

Optional alias to the certificate and private key to use if the keystore has more than one. If omitted, the first entry in the store will be used.

only-alias object

Reference to a certificate in the global keystore by alias

alias string required

Alias to the certificate and private key in the global keystore

port integer

TCP port number