How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microcks test API

Operations related to API and Services tests

Microcks test API is one of 6 APIs that Microcks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 7 operations across 7 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 1.14.0.

Requests are made against a single base URL, http://microcks.example.com/api.

7 operations 7 paths 22 schemas 5 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.14.0
Server
http://microcks.example.com/api
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Microcks test API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (jwt-bearer) using the clientCredentials flow, exposing 3 scopes. By default, every request must be authenticated.

  • jwt-bearer — JWT Bearer acquired using OAuth 2 Authentication flow or Direct Access Grant

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 5 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

test 7

Operations related to API and Services tests

POST
/tests
Create a new Test
CreateTest body → 201
GET
/tests/service/{serviceId}
Get TestResults by Service
GetTestResultsByService 1 param → 200
GET
/tests/service/{serviceId}/count
Get the TestResults for Service counter
GetTestResultsByServiceCounter 1 param → 200
GET
/tests/{id}
Get TestResult
GetTestResult 1 param → 200
GET
/tests/{id}/messages/{testCaseId}
Get messages for TestCase
GetMessagesByTestCase 2 params → 200
POST
/tests/{id}/testCaseResult
Report and create a new TestCaseResult
ReportTestCaseResult 1 param body → 200
GET
/tests/{id}/events/{testCaseId}
Get events for TestCase
GetEventsByTestCase 2 params → 200

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are TestResult (15 properties), OAuth2ClientContext (8 properties), TestRequest (8 properties), Message (6 properties). Each schema is shown below with its type and property counts.

OperationHeaders
object
Specification of additional headers for a Service/API operations. Keys are operation name or "globals" (if header applies to all), values are Header objects DT…
TestCaseResult
object
Companion objects for TestResult. Each TestCaseResult correspond to a particuliar service operation / action reference by the operationName field. TestCaseResu…
4 properties 3 required
Header
object
Transport headers for both Requests and Responses
2 properties 2 required
UnidirectionalEvent
object
Representation of an unidirectional exchange as an event message
OAuth2ClientContext
object
Represents a volatile OAuth2 client context usually associated with a Test request
8 properties 4 required
TestResult
object
Represents the result of a Service or API test run by Microcks. Tests are related to a service and made of multiple test cases corresponding to each operations…
15 properties 9 required
TestCaseReturnDTO
object
1 property 1 required
Message
object
Common structure for Request, Response and EventMessage
6 properties 2 required
AbstractExchange
object
Abstract bean representing a Service or API Exchange.
1 property 1 required
HeaderDTO
object
Data Transfert Object for headers of both Requests and Responses
2 properties 2 required
Parameter
object
Companion objects for Request representing query parameter
2 properties 2 required
TestRequest
object
Test request is a minimalist wrapper for requesting the launch of a new test
8 properties 4 required
Request
A mock invocation or test request
TestStepResult
object
TestStepResult is an entity embedded within TestCaseResult. They are created for each request associated with an operation / action of a microservice.
5 properties 2 required
Counter
object
A simple Counter type.
1 property
EventMessage
object
A simple event message published or received in an asynchronous exchange
SecretRef
object
Lightweight reference for an existing Secret
2 properties 2 required
TestRunnerType
string
Type of test strategy (different strategies are implemented by different runners)
RequestResponsePair
object
Request associated with corresponding Response
Response
A mock invocation or test response
OAuth2GrantType
string
Enumeration for the different supported grants/flows of OAuth2
OAuth2AuthorizedClient
object
OAuth2 authorized client that performed a test
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microcks-test-api-openapi.yml Raw ↑

Other APIs Microcks publishes across the network.

Microcks config API
Microcks job API
Microcks metrics API
Microcks mock API
Microcks Resources API
Where this information came from

This is an independent, third-party profile of Microcks test API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.