API docs by Redocly

GripMock API Schema (3.0.0)

Download OpenAPI specification:Download

URL: https://github.com/bavix/gripmock-openapi License: MIT

Documentation and API specification GripMock.

healthcheck

Healthcheck

Liveness check

This endpoint indicates that the service is alive and ready to handle requests

Authorizations:
None

Responses

Response samples

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

Readiness check

The test indicates readiness to receive traffic

Authorizations:
None

Responses

Response samples

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

dashboard

Dashboard and runtime telemetry

Dashboard aggregate payload

Returns combined dashboard counters, runtime metadata, and process state in one response.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "appName": "string",
  • "version": "string",
  • "goVersion": "string",
  • "compiler": "string",
  • "goos": "string",
  • "goarch": "string",
  • "numCPU": 1,
  • "startedAt": "2019-08-24T14:15:22Z",
  • "uptimeSeconds": 0,
  • "ready": true,
  • "historyEnabled": true,
  • "totalServices": 0,
  • "totalStubs": 0,
  • "usedStubs": 0,
  • "unusedStubs": 0,
  • "totalSessions": 0,
  • "runtimeDescriptors": 0,
  • "totalHistory": 0,
  • "historyErrors": 0
}

Dashboard overview metrics

Returns lightweight aggregate counters for admin UI dashboard.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "totalServices": 0,
  • "totalStubs": 0,
  • "usedStubs": 0,
  • "unusedStubs": 0,
  • "totalSessions": 0,
  • "runtimeDescriptors": 0,
  • "totalHistory": 0,
  • "historyErrors": 0
}

Dashboard runtime and build info

Returns GripMock build metadata and current runtime process information.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "appName": "string",
  • "version": "string",
  • "goVersion": "string",
  • "compiler": "string",
  • "goos": "string",
  • "goarch": "string",
  • "numCPU": 1,
  • "startedAt": "2019-08-24T14:15:22Z",
  • "uptimeSeconds": 0,
  • "ready": true,
  • "historyEnabled": true,
  • "totalServices": 0,
  • "totalStubs": 0,
  • "totalSessions": 0,
  • "runtimeDescriptors": 0
}

sessions

Session management

Session options

Returns distinct non-empty session IDs available in current stubs.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "sessions": [
    ]
}

services

Services reflection

Services

List of registered services

Authorizations:
None

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Service methods

List of registered service methods

Authorizations:
None
path Parameters
serviceID
required
string

ID of service

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Service method details

Returns exact metadata for one method (by short name or full method id).

Authorizations:
None
path Parameters
serviceID
required
string

Full service name (e.g. helloworld.Greeter)

methodID
required
string

Method short name (e.g. SayHello) or full id (e.g. helloworld.Greeter/SayHello)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "methodType": "unary",
  • "requestType": "string",
  • "responseType": "string",
  • "requestSchema": {
    },
  • "responseSchema": {
    },
  • "clientStreaming": true,
  • "serverStreaming": true
}

Service details

Returns exact metadata for one service including all methods and streaming capabilities.

Authorizations:
None
path Parameters
serviceID
required
string

Full service name (e.g. helloworld.Greeter)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "package": "string",
  • "name": "string",
  • "methods": [
    ]
}

Remove service

Removes a service added via POST /descriptors. Services from startup (proto path) cannot be removed.

Authorizations:
None
path Parameters
serviceID
required
string

Full service name (e.g. helloworld.Greeter)

Responses

stubs

Stubs storage and matching

Getting a list of used stubs

The list is needed to quickly find used stubs

Authorizations:
None

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Getting a list of unused stubs

The list is needed to quickly find unused stubs

Authorizations:
None

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Getting a list of stubs

The list of stubs is required to view all added stubs

Authorizations:
None

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new stub to the store

Creates a new stub or multiple stubs and adds them to the storage

Authorizations:
None
Request Body schema: application/json
required

Create a new stub in the store

One of
Array
id
string <uuid> (ID)
service
required
string
method
required
string
priority
integer
Default: 0

Priority of the stub. Higher priority stubs are matched first.

object (StubHeaders)
required
object (StubInput)
Array of objects (StubInput)

Inputs to match against. If multiple inputs are provided, the stub will be matched if any of the inputs match.

required
object (StubOutput)
object (StubOptions)

Optional behavior settings for a stub

Responses

Request samples

Content type
application/json
Example
[ ]

Response samples

Content type
application/json
[ ]

Remove all stubs

Completely clears the stub storage

Authorizations:
None

Responses

Deletes a batch of stubs by IDs

Takes IDs as input and deletes them

Authorizations:
None
Request Body schema: application/json
required

Delete stubs by their IDs

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

Authorizations:
None
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",
  • "priority": 0,
  • "headers": {
    },
  • "input": {
    },
  • "inputs": [
    ],
  • "output": {
    },
  • "options": {
    }
}

Deletes stub by ID

The method removes the stub by ID

Authorizations:
None
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

Authorizations:
None
Request Body schema: application/json
required

Search criteria including service, method, headers and data to match against stubs

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
}

Inspect stub matching decision path

Returns detailed matching stages/candidates for a query without consuming stub times.

Authorizations:
None
Request Body schema: application/json
required

Inspect criteria including service, method, optional headers/session and input messages

id
string <uuid> (ID)
service
required
string
method
required
string
session
string
object
Array of objects

Responses

Request samples

Content type
application/json
{
  • "id": "51c50050-ec27-4dae-a583-a32ca71a1dd5",
  • "service": "string",
  • "method": "string",
  • "session": "string",
  • "headers": { },
  • "input": [
    ]
}

Response samples

Content type
application/json
{
  • "service": "string",
  • "method": "string",
  • "session": "string",
  • "matchedStubId": "string",
  • "similarStubId": "string",
  • "fallbackToMethod": true,
  • "error": "string",
  • "stages": [
    ],
  • "candidates": [
    ]
}

history

Recorded gRPC call history

Get call history

Returns recorded gRPC calls (when history is enabled)

Authorizations:
None

Responses

Response samples

Content type
application/json
[
  • {
    }
]

verify

Verify call count expectations

Verify call counts

Asserts that a method was called a specified number of times

Authorizations:
None
Request Body schema: application/json
required
service
required
string
method
required
string
expectedCount
required
integer >= 0

Responses

Request samples

Content type
application/json
{
  • "service": "string",
  • "method": "string",
  • "expectedCount": 0
}

Response samples

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

descriptors

Protocol Buffer descriptors (FileDescriptorSet)

List service IDs from REST-added descriptors

Returns service IDs (e.g. helloworld.Greeter) added via POST /descriptors. Use DELETE /services/{serviceID} to remove.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "serviceIDs": [
    ]
}

Upload FileDescriptorSet

Accepts binary Protocol Buffers FileDescriptorSet. Registers descriptors for dynamic service discovery. Returns service IDs for later removal via DELETE /services/{serviceID}.

Authorizations:
None
Request Body schema: application/octet-stream
required
string <binary>

Responses

Response samples

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

mcp

Model Context Protocol (MCP) integration

MCP transport metadata

Returns MCP server metadata, supported protocol versions and transport details.

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "protocolVersion": "2024-11-05",
  • "serverName": "gripmock",
  • "serverVersion": "3.7.1",
  • "transport": {
    },
  • "methods": [
    ],
  • "tools": [
    ]
}

MCP JSON-RPC endpoint

Accepts MCP JSON-RPC requests (initialize, ping, tools/list, tools/call) and returns JSON-RPC responses.

Authorizations:
None
Request Body schema: application/json
required
jsonrpc
required
string
(string or null) or (integer or null) (McpID)
method
required
string
object

Responses

Request samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": 10,
  • "method": "tools/call",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": 10,
  • "result": {
    }
}