OpenAPI
Get OpenAPI document for mock API
Mock APIs
Teams
Organisations
Data sources
Database connections
Usage
Access control
Stub Mappings
- GETGet all stub mappings
- POSTCreate a new stub mapping
- DELDelete all stub mappings
- POSTReset stub mappings
- POSTPersist stub mappings
- POSTImport stub mappings
- GETGet stub mapping by ID
- PUTUpdate a stub mapping
- DELDelete a stub mapping
- POSTFind stub mappings matching metadata
- POSTDelete stub mappings matching metadata
Requests
OpenAPI
Imports
OpenAPI
Get OpenAPI document for mock API
GET
/
v1
/
mock-apis
/
{mockApiId}
/
open-api
curl --request GET \
--url https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/open-api \
--header 'Authorization: Basic <encoded-value>'
{
"openApi": {
"doc": "openapi: 3.1.0\ninfo:\n title: Customer\nContacts\nManagement\nAPI\n\\nn\ndescription: API\nfor\nmanaging\ncustomer\ncontacts\nincluding\npersonal\nand\nprofessional\n\\nn\ndetails\n\\nn\nversion: 1.0.0\n\\nnservers:\n\\nn-\nurl: https\n://dev-openapi-testing.wiremockapi.cloud"
}
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
The ID of the Mock API
Required string length:
5 - 10
curl --request GET \
--url https://wmc.wiremockapi.cloud/v1/mock-apis/{mockApiId}/open-api \
--header 'Authorization: Basic <encoded-value>'
{
"openApi": {
"doc": "openapi: 3.1.0\ninfo:\n title: Customer\nContacts\nManagement\nAPI\n\\nn\ndescription: API\nfor\nmanaging\ncustomer\ncontacts\nincluding\npersonal\nand\nprofessional\n\\nn\ndetails\n\\nn\nversion: 1.0.0\n\\nnservers:\n\\nn-\nurl: https\n://dev-openapi-testing.wiremockapi.cloud"
}
}