Microcks Examples

Microcks Examples, formally the APIExamples format, is Microcks’ own specification for defining reusable request and response examples that feed its mocks and contract tests. Instead of burying sample payloads inside an API definition, you describe them in a dedicated, portable document that Microcks imports to stand up realistic mock services and to verify that a live API still matches its expected examples.

• Standalone example artifact - Examples live in their own file rather than being trapped inside the API contract.
• Mock generation - Each example becomes a ready-to-call mock response, so consumers can build against an API before it exists.
• Contract testing - The same examples are replayed against a real implementation to catch drift between spec and behavior.
• Multi-spec support - Works alongside OpenAPI, AsyncAPI, GraphQL, and gRPC definitions.

In real API operations the APIExamples format is how teams keep mocking and testing in sync from a single source of truth: designers publish examples early for frontend and partner teams to consume, and CI pipelines reuse those same examples to assert the running API still honors them. As agents increasingly rely on example payloads to learn how to call an API, a clean, machine-readable example format becomes a practical part of making a service agent-ready.