API docs by Redocly

GripMock API Schema (3.0.0)

Download OpenAPI specification:Download

stubs

Stubs storage management

Getting a list of used stubs

The list is needed to quickly find used stubs

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Getting a list of unused stubs

The list is needed to quickly find unused stubs

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Getting a list of stubs

The list of stubs is required to view all added stubs

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new stub to the store

Add a new stub to the store

Request Body schema: application/json
required

Create a new pet in the store

One of
Array
id
string <uuid> (ID)
service
required
string
method
required
string
object (StubHeaders)
required
object (StubInput)
required
object (StubOutput)

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

Content type
application/json
[ ]

Remove all stubs

Completely clears the stub storage

Responses

Deletes a pack by IDs

Takes IDs as input and deletes them

Request Body schema: application/json
required

Create a new pet in the store

Array
string <uuid> (ID)

Responses

Request samples

Content type
application/json
[
  • "51c50050-ec27-4dae-a583-a32ca71a1dd5"
]

Get Stub by ID

Searches for Stub by ID

path Parameters
uuid
required
string <uuid> (ID)
Example: 51c50050-ec27-4dae-a583-a32ca71a1dd5

ID of stub

Responses

Response samples

Content type
application/json
{
  • "id": "51c50050-ec27-4dae-a583-a32ca71a1dd5",
  • "service": "Gripmock",
  • "method": "SayHello",
  • "headers": {
    },
  • "input": {
    },
  • "output": {
    }
}

Deletes stub by ID

The method removes the stub by ID

path Parameters
uuid
required
string <uuid> (ID)
Example: 51c50050-ec27-4dae-a583-a32ca71a1dd5

ID of stub

Responses

Stub storage search

Performs a search for a stub by the given conditions

Request Body schema: application/json
required

Description of filtering

id
string <uuid> (ID)
service
required
string
method
required
string
object
required
object

Responses

Request samples

Content type
application/json
{
  • "id": "51c50050-ec27-4dae-a583-a32ca71a1dd5",
  • "service": "Gripmock",
  • "method": "SayHello",
  • "headers": {
    },
  • "data": { }
}

Response samples

Content type
application/json
{
  • "headers": {
    },
  • "data": { },
  • "error": "Message not found",
  • "code": 3
}

services

Services reflection

Services

List of registered services

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Service methods

List of registered service methods

path Parameters
serviceID
required
string

ID of service

Responses

Response samples

Content type
application/json
[
  • {
    }
]

dashboard

Dashboard

healthcheck

Healthcheck

Liveness check

The test says that the service is alive and yet

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "time": "2019-08-24T14:15:22Z"
}

Readiness check

The test indicates readiness to receive traffic

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "time": "2019-08-24T14:15:22Z"
}