microcks is a free, open source api development & testing project written in Java and released under Apache-2.0. It has 2,044 GitHub stars, 367 forks and 58 open issues, and was last pushed 7 hours ago. On this registry it ranks #77 of 103 tracked projects in API Development & Testing, with 5 head-to-head comparisons available.

What is microcks?

What it is

Microcks is an open source, cloud native API mocking and testing tool and a Cloud Native Computing Foundation incubating project. It lives in the developer tools and API development ecosystem, where teams need to exercise service contracts before implementations are ready or before changes are trusted. The project turns existing API and microservice assets, including OpenAPI specs, AsyncAPI specs, gRPC protobuf, GraphQL schema, Postman collections, and SoapUI projects, into live mocks for applications, testers, and integration pipelines.

The concrete problem it solves is the gap between API design, service implementation, and verification. Instead of maintaining separate mock data, test scripts, and contract checks, Microcks reuses the same specification assets for both mocking and testing. This lets teams run contract conformance and non-regression tests against an API implementation, while also providing mock servers for dependent services, event-driven flows, GraphQL interactions, and asynchronous interfaces.

Key capabilities

  • Converts OpenAPI specs, AsyncAPI specs, gRPC protobuf, GraphQL schema, Postman collections, and SoapUI projects into live API mocks.
  • Runs contract conformance and non-regression tests against API implementations by reusing the same imported assets.
  • Supports event-driven and asynchronous API workflows through AsyncAPI specification and event-driven project topics.
  • Provides CI integrations with Jenkins, GitHub Actions, and Tekton through a simple command-line interface.
  • Targets cloud native delivery environments, with Kubernetes and CNCF listed among the project topics.

Who uses it and how

  • Teams use existing specification files and collection formats to create live mocks for services before implementations are complete.
  • Teams use Microcks to verify that a service implementation conforms to its contract and does not regress after changes.
  • Teams place the Microcks CLI into Jenkins, GitHub Actions, and Tekton pipelines so mock creation and contract testing run automatically.
  • Teams use AsyncAPI assets to mock and test asynchronous interfaces, including project topics listed under asyncapi-specification and event-driven.

Getting started

The README points users to the Microcks documentation and community resources, and the project is published through a Quay.io container repository, an Artifact Hub package, and a Maven Central artifact identifier. Teams deploying Microcks themselves should start with the documented setup path and choose a published version rather than the development version shown in the build status.

When to use it β€” and when not to

Microcks is a good fit when a team already has API assets in the formats listed above and wants one tool to create mocks and run contract or non-regression tests. The provided facts do not describe database, storage, SMTP, or hosted-service requirements, so teams needing a fully managed option or a complete self-hosting checklist must inspect the documentation before committing. The project is Apache-2.0 licensed and Java-based, but metadata shows 58 open issues and a development version of 1.15.0-SNAPSHOT, so teams should weigh ongoing maintenance and version selection.

project readme (upstream, from github) β€” read inline

GitHub Workflow Status Container Version License Project Chat Artifact HUB CNCF Landscape

Microcks - cloud native tool for API Mocking & Testing

Microcks is a platform for turning your API and microservices assets - OpenAPI specs, AsyncAPI specs, gRPC protobuf, GraphQL schema, Postman collections, SoapUI projects - into live mocks in seconds.

It also reuses these assets to run contract conformance and non-regression tests against your API implementation. We provide integrations with Jenkins, GitHub Actions, Tekton and many others through a simple CLI.

LFX Health Score LFX Contributors LFX Active Contributors

Getting Started

To get involved with our community, please familiarize yourself with the project's Code of Conduct.

Build Status

The current development version is 1.15.0-SNAPSHOT.

GitHub Workflow Status

Sonarcloud Quality metrics

Code Smells Reliability Rating Bugs Coverage Technical Debt Security Rating Maintainability Rating

Fossa license and security scans

FOSSA Status FOSSA Status FOSSA Status

Signature, Provenance, SBOM

Static Badge

OpenSSF best practices

CII Best Practices OpenSSF Scorecard

Versions

Here are the naming conventions we're using for current releases, ongoing development maintenance activities.

Status Version Branch Container images tags
Stable 1.14.0 release-1.14 1.14.0, latest
Dev 1.15.0-SNAPSHOT master nightly
Maintenance 1.13.3-SNAPSHOT 1.13.x maintenance

Have a look at our tested configurations to know more about the versions of dependencies and integrations that we are using for development and testing.

How to build Microcks

The build instructions are available in the building guide.

Thanks to the community!

Contributors Forkers repo roster for @microcks/microcks

Frequently asked questions

Is microcks free to use?

microcks is open source under the Apache-2.0 licence. There is no licence fee and no seat count β€” you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does microcks do?

The open source, cloud native tool for API Mocking and Testing. Microcks is a Cloud Native Computing Foundation incubating project πŸš€

What is microcks written in?

microcks is primarily written in Java. Its source is publicly available at https://github.com/microcks/microcks, and it has 2,044 GitHub stars.