Skip to content

WireMock API

by wiremock.org

Open documentation ↗

Overview

WireMock is a popular open-source tool for API mock testing with over 5 million downloads per month.

WireMock is a development API from wiremock.org. It needs no API key. It is served over plain HTTP. Its OpenAPI description documents 33 endpoints.

At a glance

Authentication
No auth
HTTPS
No
CORS
Unknown
Category
Development
Version
2.35.0
Endpoints
33
Spec updated
2023-03-06

Endpoints

MethodPathWhat it does
GET/__admin/mappingsGet all stub mappings
POST/__admin/mappingsCreate a new stub mapping
DELETE/__admin/mappingsDelete all stub mappings
POST/__admin/mappings/find-by-metadataFind stubs by matching on their metadata
POST/__admin/mappings/importImport stub mappings
POST/__admin/mappings/remove-by-metadataDelete stub mappings matching metadata
POST/__admin/mappings/resetReset stub mappings
POST/__admin/mappings/savePersist stub mappings
GET/__admin/mappings/{stubMappingId}Get stub mapping by ID
PUT/__admin/mappings/{stubMappingId}Update a stub mapping
DELETE/__admin/mappings/{stubMappingId}Delete a stub mapping
POST/__admin/near-misses/requestFind near misses matching specific request
POST/__admin/near-misses/request-patternFind near misses matching request pattern
POST/__admin/recordings/snapshotTake a snapshot recording
POST/__admin/recordings/startStart recording
GET/__admin/recordings/statusGet recording status
POST/__admin/recordings/stopStop recording
GET/__admin/requestsGet all requests in journal
DELETE/__admin/requestsDelete all requests in journal
POST/__admin/requests/countCount requests by criteria
POST/__admin/requests/findFind requests by criteria
POST/__admin/requests/removeRemove requests by criteria
POST/__admin/requests/remove-by-metadataDelete requests mappings matching metadata
POST/__admin/requests/resetdeprecatedEmpty the request journal
GET/__admin/requests/unmatchedFind unmatched requests
GET/__admin/requests/unmatched/near-missesRetrieve near-misses for all unmatched requests
GET/__admin/requests/{requestId}Get request by ID
DELETE/__admin/requests/{requestId}Delete request by ID
POST/__admin/resetReset mappings and request journal
GET/__admin/scenariosGet all scenarios
POST/__admin/scenarios/resetReset the state of all scenarios
POST/__admin/settingsUpdate global settings
POST/__admin/shutdownShutdown the WireMock server

Questions

Does the WireMock API need an API key?

No. The WireMock API can be called without an API key or sign-up, which makes it handy for prototypes and front-end demos.

Does the WireMock API support HTTPS?

The WireMock API is listed as HTTP only, so avoid sending secrets to it.

How many endpoints does the WireMock API have?

Its OpenAPI description lists 33 endpoints in version 2.35.0. All of them are shown on this page.

What are alternatives to the WireMock API?

Other Development APIs include Cloudflare, Azure DevOps, IPify, App Store Connect API, StackExchange.

Compare alternatives →

Listed from APIs.guru (CC0).