swagger.wiremock-admin-api.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of wiremock-standalone Show documentation
Show all versions of wiremock-standalone Show documentation
A web service test double for all occasions - standalone edition
The newest version!
{
"openapi": "3.0.0",
"info": {
"title": "WireMock",
"version": "3.9.2",
"description": "WireMock offers a REST API for administration, troubleshooting and analysis purposes"
},
"servers": [
{
"url": "/"
}
],
"tags": [
{
"name": "Stub Mappings",
"description": "Operations on stub mappings",
"externalDocs": {
"description": "User documentation",
"url": "https://wiremock.org/docs/stubbing/"
}
},
{
"name": "Requests",
"description": "Logged requests and responses received by the mock service",
"externalDocs": {
"description": "User documentation",
"url": "https://wiremock.org/docs/verifying/"
}
},
{
"name": "Near Misses",
"description": "Near misses allow querying of received requests or request patterns according to similarity",
"externalDocs": {
"description": "User documentation",
"url": "https://wiremock.org/docs/verifying/#near-misses"
}
},
{
"name": "Recordings",
"description": "Stub mapping record and snapshot functions",
"externalDocs": {
"description": "User documentation",
"url": "https://wiremock.org/docs/record-playback/"
}
},
{
"name": "Scenarios",
"description": "Scenarios support modelling of stateful behaviour",
"externalDocs": {
"description": "User documentation",
"url": "https://wiremock.org/docs/stateful-behaviour/"
}
},
{
"name": "Files",
"description": "Manage the files used to support WireMock stubs"
},
{
"name": "System",
"description": "Global operations"
}
],
"externalDocs": {
"description": "WireMock user documentation",
"url": "https://wiremock.org/docs/"
},
"paths": {
"/__admin/mappings": {
"get": {
"operationId": "getAllStubMappings",
"summary": "Get all stub mappings",
"tags": [
"Stub Mappings"
],
"parameters": [
{
"description": "The maximum number of results to return",
"in": "query",
"name": "limit",
"required": false,
"example": 10,
"schema": {
"type": "integer"
}
},
{
"description": "The start index of the results to return",
"in": "query",
"name": "offset",
"required": false,
"example": 0,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/stub-mappings"
},
"example": {
"meta": {
"total": 2
},
"mappings": [
{
"id": "76ada7b0-49ae-4229-91c4-396a36f18e09",
"uuid": "76ada7b0-49ae-4229-91c4-396a36f18e09",
"request": {
"method": "GET",
"url": "/search?q=things",
"headers": {
"Accept": {
"equalTo": "application/json"
}
}
},
"response": {
"status": 200,
"jsonBody": [
"thing1",
"thing2"
],
"headers": {
"Content-Type": "application/json"
}
}
},
{
"request": {
"method": "POST",
"urlPath": "/some/things",
"bodyPatterns": [
{
"equalToXml": "123 "
},
"enablePlaceholders": {
"type": "boolean"
},
"placeholderOpeningDelimiterRegex": {
"type": "string",
"example": "["
},
"placeholderClosingDelimiterRegex": {
"type": "string",
"example": "]"
}
},
"required": [
"equalToXml"
]
},
"matches-xpath-pattern": {
"title": "XPath match",
"type": "object",
"properties": {
"matchesXPath": {
"oneOf": [
{
"type": "string",
"example": "//Order/Amount"
},
{
"type": "object",
"allOf": [
{
"properties": {
"expression": {
"type": "string",
"example": "//Order/Amount"
}
}
},
{
"$ref": "#/components/schemas/content-pattern"
}
],
"required": [
"expression"
]
}
]
},
"xPathNamespaces": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"matchesXPath"
]
},
"matches-json-schema-pattern": {
"title": "JSON Schema match",
"type": "object",
"properties": {
"matchesJsonSchema": {
"oneOf": [
{
"type": "string",
"example": "//Order/Amount"
},
{
"type": "object",
"allOf": [
{
"properties": {
"expression": {
"type": "string",
"example": "//Order/Amount"
}
}
},
{
"$ref": "#/components/schemas/content-pattern"
}
],
"required": [
"expression"
]
}
]
},
"xPathNamespaces": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"matchesJsonSchema"
]
},
"absent-pattern": {
"title": "Absent matcher",
"type": "object",
"properties": {
"absent": {
"type": "boolean"
}
},
"required": [
"absent"
]
},
"and-pattern": {
"title": "Logical AND matcher",
"type": "object",
"properties": {
"and": {
"type": "array",
"items": {
"$ref": "#/components/schemas/content-pattern"
}
}
},
"required": [
"and"
]
},
"or-pattern": {
"title": "Logical AND matcher",
"type": "object",
"properties": {
"or": {
"type": "array",
"items": {
"$ref": "#/components/schemas/content-pattern"
}
}
},
"required": [
"or"
]
},
"has-exactly-multivalue-pattern": {
"title": "Has exactly multi value matcher",
"type": "object",
"properties": {
"hasExactly": {
"type": "array",
"items": {
"$ref": "#/components/schemas/content-pattern"
}
}
},
"required": [
"hasExactly"
]
},
"includes-multivalue-pattern": {
"title": "Has exactly multi value matcher",
"type": "object",
"properties": {
"includes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/content-pattern"
}
}
},
"required": [
"includes"
]
},
"request-pattern": {
"type": "object",
"example": "{\n \"urlPath\" : \"/charges\",\n \"method\" : \"POST\",\n \"headers\" : {\n \"Content-Type\" : {\n \"equalTo\" : \"application/json\"\n }\n }\n",
"properties": {
"scheme": {
"type": "string",
"enum": [
"http",
"https"
],
"description": "The scheme (protocol) part of the request URL"
},
"host": {
"type": "string",
"description": "The hostname part of the request URL"
},
"port": {
"type": "integer",
"minimum": 1,
"maximum": 65535,
"description": "The HTTP port number of the request URL"
},
"method": {
"type": "string",
"pattern": "^[A-Z]+$",
"description": "The HTTP request method e.g. GET"
},
"url": {
"type": "string",
"description": "The path and query to match exactly against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified."
},
"urlPath": {
"type": "string",
"description": "The path to match exactly against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified."
},
"urlPathPattern": {
"type": "string",
"description": "The path regex to match against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified."
},
"urlPattern": {
"type": "string",
"description": "The path and query regex to match against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified."
},
"pathParameters": {
"type": "object",
"description": "Path parameter patterns to match against in the : { \"\": \"\" } form. Can only\nbe used when the urlPathPattern URL match type is in use and all keys must be present as variables\nin the path template.\n",
"additionalProperties": {
"$ref": "#/components/schemas/content-pattern"
}
},
"queryParameters": {
"type": "object",
"description": "Query parameter patterns to match against in the : { \"\": \"\" } form",
"additionalProperties": {
"$ref": "#/components/schemas/content-pattern"
}
},
"formParameters": {
"type": "object",
"description": "application/x-www-form-urlencoded form parameter patterns to match against in the : { \"\": \"\" } form",
"additionalProperties": {
"$ref": "#/components/schemas/content-pattern"
}
},
"headers": {
"type": "object",
"description": "Header patterns to match against in the : { \"\": \"\" } form",
"additionalProperties": {
"$ref": "#/components/schemas/content-pattern"
}
},
"basicAuthCredentials": {
"type": "object",
"description": "Pre-emptive basic auth credentials to match against",
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"username",
"password"
]
},
"cookies": {
"type": "object",
"description": "Cookie patterns to match against in the : { \"\": \"\" } form",
"additionalProperties": {
"$ref": "#/components/schemas/content-pattern"
}
},
"bodyPatterns": {
"type": "array",
"description": "Request body patterns to match against in the : { \"\": \"\" } form",
"items": {
"$ref": "#/components/schemas/content-pattern"
}
},
"customMatcher": {
"type": "object",
"description": "Custom request matcher to match against",
"properties": {
"name": {
"type": "string",
"description": "The matcher's name specified in the implementation of the matcher."
},
"parameters": {
"type": "object"
}
}
},
"multipartPatterns": {
"type": "array",
"description": "Multipart patterns to match against headers and body.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"matchingType": {
"type": "string",
"description": "Determines whether all or any of the parts must match the criteria for an overall match.",
"default": "ANY",
"enum": [
"ALL",
"ANY"
]
},
"headers": {
"type": "object",
"description": "Header patterns to match against in the : { \"\": \"\" } form",
"additionalProperties": {
"$ref": "#/components/schemas/content-pattern"
}
},
"bodyPatterns": {
"type": "array",
"description": "Body patterns to match against in the : { \"\": \"\" } form",
"items": {
"$ref": "#/components/schemas/content-pattern"
}
}
}
}
}
}
},
"delay-distribution": {
"type": "object",
"description": "The delay distribution. Valid property configuration is either median/sigma/type or lower/type/upper.",
"oneOf": [
{
"title": "Log normal",
"description": "Log normal randomly distributed response delay.",
"type": "object",
"properties": {
"median": {
"type": "integer"
},
"sigma": {
"type": "number"
},
"type": {
"type": "string",
"enum": [
"lognormal"
]
}
},
"required": [
"median",
"sigma"
]
},
{
"title": "Uniform",
"description": "Uniformly distributed random response delay.",
"type": "object",
"properties": {
"lower": {
"type": "integer"
},
"upper": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"uniform"
]
}
},
"required": [
"lower",
"upper"
]
},
{
"title": "Fixed",
"description": "Fixed response delay.",
"type": "object",
"properties": {
"milliseconds": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"fixed"
]
}
},
"required": [
"milliseconds"
]
}
]
},
"response-definition": {
"allOf": [
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "The HTTP status code to be returned"
},
"statusMessage": {
"type": "string",
"description": "The HTTP status message to be returned"
},
"headers": {
"type": "object",
"description": "Map of response headers to send",
"additionalProperties": {
"type": "string"
}
},
"additionalProxyRequestHeaders": {
"type": "object",
"description": "Extra request headers to send when proxying to another host.",
"additionalProperties": {
"type": "string"
}
},
"removeProxyRequestHeaders": {
"type": "array",
"description": "Request headers to remove when proxying to another host.",
"items": {
"type": "string"
}
},
"body": {
"type": "string",
"description": "The response body as a string. Only one of body, base64Body, jsonBody or bodyFileName may be specified."
},
"base64Body": {
"$ref": "#/components/schemas/base64-string"
},
"jsonBody": {
"description": "The response body as a JSON object. Only one of body, base64Body, jsonBody or bodyFileName may be specified.",
"oneOf": [
{
"type": "object"
},
{
"type": "array"
}
]
},
"bodyFileName": {
"type": "string",
"description": "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.",
"example": "user-profile-responses/user1.json"
},
"fault": {
"type": "string",
"description": "The fault to apply (instead of a full, valid response).",
"enum": [
"CONNECTION_RESET_BY_PEER",
"EMPTY_RESPONSE",
"MALFORMED_RESPONSE_CHUNK",
"RANDOM_DATA_THEN_CLOSE"
]
},
"fixedDelayMilliseconds": {
"type": "integer",
"description": "Number of milliseconds to delay be before sending the response."
},
"delayDistribution": {
"$ref": "#/components/schemas/delay-distribution"
},
"chunkedDribbleDelay": {
"type": "object",
"description": "The parameters for chunked dribble delay - chopping the response into pieces and sending them at delayed intervals",
"properties": {
"numberOfChunks": {
"type": "integer"
},
"totalDuration": {
"type": "integer"
}
},
"required": [
"numberOfChunks",
"totalDuration"
]
},
"fromConfiguredStub": {
"type": "boolean",
"description": "Read-only flag indicating false if this was the default, unmatched response. Not present otherwise."
},
"proxyBaseUrl": {
"type": "string",
"description": "The base URL of the target to proxy matching requests to."
},
"proxyUrlPrefixToRemove": {
"type": "string",
"description": "A path segment to remove from the beginning in incoming request URL paths before proxying to the target."
},
"transformerParameters": {
"type": "object",
"description": "Parameters to apply to response transformers."
},
"transformers": {
"type": "array",
"description": "List of names of transformers to apply to this response.",
"items": {
"type": "string"
}
}
}
}
]
},
"stub-mapping": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "This stub mapping's unique identifier"
},
"uuid": {
"type": "string",
"description": "Alias for the id"
},
"name": {
"type": "string",
"description": "The stub mapping's name"
},
"request": {
"$ref": "#/components/schemas/request-pattern"
},
"response": {
"$ref": "#/components/schemas/response-definition"
},
"persistent": {
"type": "boolean",
"description": "Indicates that the stub mapping should be persisted immediately on create/update/delete and survive resets to default."
},
"priority": {
"type": "integer",
"description": "This stub mapping's priority relative to others. 1 is highest.",
"minimum": 1
},
"scenarioName": {
"type": "string",
"description": "The name of the scenario that this stub mapping is part of"
},
"requiredScenarioState": {
"type": "string",
"description": "The required state of the scenario in order for this stub to be matched."
},
"newScenarioState": {
"type": "string",
"description": "The new state for the scenario to be updated to after this stub is served."
},
"postServeActions": {
"type": "object",
"description": "A map of the names of post serve action extensions to trigger and their parameters."
},
"serveEventListeners": {
"type": "array",
"description": "The list of serve event listeners",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"requestPhases": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BEFORE_MATCH",
"AFTER_MATCH",
"BEFORE_RESPONSE_SENT",
"AFTER_COMPLETE"
]
}
},
"parameters": {
"type": "object"
}
}
}
},
"metadata": {
"type": "object",
"description": "Arbitrary metadata to be used for e.g. tagging, documentation. Can also be used to find and remove stubs."
}
},
"additionalProperties": false
},
"stub-mappings": {
"type": "object",
"properties": {
"mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/stub-mapping"
}
},
"meta": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"example": 4
}
},
"required": [
"total"
]
}
},
"additionalProperties": false
},
"bad-request-entity": {
"title": "Bad request entity",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"source": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
}
}
}
}
}
},
"logged-request": {
"type": "object",
"properties": {
"method": {
"description": "The HTTP request method",
"type": "string",
"example": "GET"
},
"url": {
"description": "The path and query to match exactly against",
"type": "string",
"example": "/received-request/2"
},
"absoluteUrl": {
"description": "The full URL to match against",
"type": "string",
"example": "http://localhost:56738/received-request/2"
},
"headers": {
"description": "Header patterns to match against in the : { \"\": \"\" } form",
"type": "object",
"example": {
"Connection": "keep-alive",
"Host": "localhost:56738",
"User-Agent": "Apache-HttpClient/4.5.1 (Java/1.7.0_51)"
}
},
"cookies": {
"description": "Cookie patterns to match against in the : { \"\": \"\" } form",
"type": "object",
"example": {}
},
"body": {
"description": "Body string to match against",
"type": "string",
"example": "Hello world"
}
}
},
"record-spec": {
"type": "object",
"properties": {
"captureHeaders": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"properties": {
"caseInsensitive": {
"type": "boolean"
}
}
},
"description": "Headers from the request to include in the generated stub mappings, mapped to parameter objects. The only parameter available is \"caseInsensitive\", which defaults to false",
"example": {
"Accept": {},
"Content-Type": {
"caseInsensitive": true
}
}
},
"extractBodyCriteria": {
"type": "object",
"description": "Criteria for extracting response bodies to a separate file instead of including it in the stub mapping",
"example": [
{
"binarySizeThreshold": "1 Mb",
"textSizeThreshold": "2 kb"
}
],
"properties": {
"binarySizeThreshold": {
"type": "string",
"default": "0",
"description": "Size threshold for extracting binary response bodies. Supports humanized size strings, e.g. \"56 Mb\". Default unit is bytes.",
"example": "18.2 GB"
},
"textSizeThreshold": {
"default": "0",
"description": "Size threshold for extracting binary response bodies. Supports humanized size strings, e.g. \"56 Mb\". Default unit is bytes.",
"example": "18.2 GB",
"type": "string"
}
}
},
"persist": {
"type": "boolean",
"default": true,
"description": "Whether to save stub mappings to the file system or just return them"
},
"repeatsAsScenarios": {
"type": "boolean",
"default": true,
"description": "When true, duplicate requests will be added to a Scenario. When false, duplicates are discarded"
},
"requestBodyPattern": {
"type": "object",
"description": "Control the request body matcher used in generated stub mappings",
"oneOf": [
{
"type": "object",
"description": "Automatically determine matcher based on content type (the default)",
"properties": {
"caseInsensitive": {
"type": "boolean",
"default": false,
"description": "If equalTo is used, match body use case-insensitive string comparison"
},
"ignoreArrayOrder": {
"type": "boolean",
"default": true,
"description": "If equalToJson is used, ignore order of array elements"
},
"ignoreExtraElements": {
"type": "boolean",
"default": true,
"description": "If equalToJson is used, matcher ignores extra elements in objects"
},
"matcher": {
"type": "string",
"enum": [
"auto"
]
}
}
},
{
"type": "object",
"description": "Always match request bodies using equalTo",
"properties": {
"caseInsensitive": {
"default": false,
"description": "Match body using case-insensitive string comparison",
"type": "boolean"
},
"matcher": {
"enum": [
"equalTo"
],
"type": "string"
}
}
},
{
"type": "object",
"description": "Always match request bodies using equalToJson",
"properties": {
"ignoreArrayOrder": {
"default": true,
"description": "Ignore order of array elements",
"type": "boolean"
},
"ignoreExtraElements": {
"default": true,
"description": "Ignore extra elements in objects",
"type": "boolean"
},
"matcher": {
"enum": [
"equalToJson"
],
"type": "string"
}
}
},
{
"type": "object",
"description": "Always match request bodies using equalToXml",
"properties": {
"matcher": {
"type": "string",
"enum": [
"equalToXml"
]
}
}
}
]
},
"transformerParameters": {
"type": "object",
"description": "List of names of stub mappings transformers to apply to generated stubs"
},
"transformers": {
"type": "array",
"description": "Parameters to pass to stub mapping transformers",
"items": {
"type": "string"
}
}
}
},
"scenario": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The scenario ID",
"example": "c8d249ec-d86d-48b1-88a8-a660e6848042"
},
"name": {
"type": "string",
"description": "The scenario name",
"example": "my_scenario"
},
"possibleStates": {
"type": "array",
"items": {
"default": "Started",
"description": "All the states this scenario can be in",
"type": "string"
},
"example": [
"Started",
"state_1",
"state_2"
]
},
"state": {
"type": "string",
"default": "Started",
"description": "The current state of this scenario",
"example": "state_2"
}
}
},
"health": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "healthy",
"description": "The status of the server",
"enum": [
"healthy",
"unhealthy"
]
},
"message": {
"type": "string",
"description": "Longer message regarding the status of the server",
"example": "Wiremock is ok"
},
"version": {
"type": "string",
"description": "The WireMock version",
"example": "3.8.0"
},
"uptimeInSeconds": {
"type": "integer",
"description": "How long the server has been running",
"example": 14355
},
"timestamp": {
"type": "string",
"description": "The current timestamp",
"example": "2024-07-03T13:16:06.172362Z"
}
}
}
}
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy