Application contact emails

yacine@microcks.io, laurent@microcks.io

Project Summary

The Kubernetes-Native multi-protocol open source enterprise testing and mocking API solution.

Project Description

The Microcks project was launched in 2015 at the emergence of containers and Kubernetes and has been designed from the ground up with cloud-native and microservices principles and design patterns.

💡From day one, Microcks had the vision of a multi-protocol API ecosystem due to the ubiquitous nature of API. This is especially true at the enterprise level where the technology strata are built over the years.

As numerous API styles and protocols coexist, a uniform way to accelerate and secure their delivery is required! Our objective is to establish Microcks as the de-facto standard tool for delivering this unified approach the Open-Source way 🙌

Microcks allows you to simulate API, easily build on-demand test and sandbox environments, and check the conformance of your API application. It makes this consistent across HTTP, gRPC, WebSockets, GraphQL, Kafka, NATS, Google PubSub, and other popular patterns and protocols of your API lifecycle. Microcks is a cross-functional collaborative platform to ease the transition to microservices, API-based cloud-native applications.

For more information on the genesis, please see our Why Microcks?

Org repo URL

https://github.com/microcks

Project repo URL

https://github.com/microcks/microcks

Additional repos

https://github.com/microcks/microcks-operator
https://github.com/microcks/microcks-backstage-provider
https://github.com/microcks/microcks.github.io
https://github.com/microcks/microcks.io
https://github.com/microcks/microcks-ansible-operator
https://github.com/microcks/microcks-jenkins-plugin
https://github.com/microcks/microcks-postman-runtime
https://github.com/microcks/microcks-docker-desktop-extension
https://github.com/microcks/microcks-cli
https://github.com/microcks/community-mocks
https://github.com/microcks/hub.microcks.io
https://github.com/microcks/test-github-action
https://github.com/microcks/import-github-action
https://github.com/microcks/api-lifecycle
https://github.com/microcks/microcks-quickstarters

Website URL

https://microcks.io/

Roadmap

Roadmap

Roadmap context

We are very ecosystem oriented and are open to interoperating with CNCF projects and open source projects to better serve our community users' interests.

Contributing Guide

https://github.com/microcks/microcks/blob/master/CONTRIBUTING.md See also our organization contribution guide: https://github.com/microcks/.github/blob/main/CONTRIBUTING.md

Code of Conduct (CoC)

https://github.com/microcks/.github/blob/main/CODE_OF_CONDUCT.md

Adopters

https://github.com/microcks/.github/blob/main/ADOPTERS.md

Contributing or Sponsoring Org

https://postman.com

Maintainers file

https://github.com/microcks/.github/blob/main/MAINTAINERS.md

IP Policy

• If the project is accepted, I agree the project will follow the CNCF IP Policy
  To pick up a draggable item, press the space bar. While dragging, use the arrow keys to move the item. Press space again to drop the item in its new position, or press escape to cancel.

Trademark and accounts

• If the project is accepted, I agree to donate all project trademarks and accounts to the CNCF
  To pick up a draggable item, press the space bar. While dragging, use the arrow keys to move the item. Press space again to drop the item in its new position, or press escape to cancel.

Why CNCF?

Microcks was started in 2015 at the emergence of containers and Kubernetes and has been designed with cloud-native and microservices principles and design patterns since day one.

It is important to put our project under the CNCF umbrella to demonstrate to the cloud-native community our commitment to manage Microcks expansion the open source way by joining the foundation and to assure our growing community of users and contributors of neutral governance. This is also a giant opportunity to encourage and grow community adoption and contributions. Last but not least, learning from others and giving back to the community is part of the maintainer's way of living!

Benefit to the Landscape

Microcks is a Kubernetes Native tool for API Mocking and Testing, and we aim to speed up, secure, and scale the company's API adoption, using an enterprise-grade universal API-first approach. Microcks is not only an API tooling “by developers, for developers” as it also aims to create a bridge between all the enterprise actors (business and product owners to developers) and assets (all kinds of API specifications and API). We think, that adding Microcks to the CNCF Landscape will help communities and enterprises to easiness cloud-native development, application life cycle management, and modernization.

Cloud Native 'Fit'

We think the project fits in the TAG App Delivery landscape since mocking tools like Microcks can speed up API and application integration tests and delivery.

Cloud Native 'Integration'

Depend on:

• https://www.keycloak.org/ For identity and access management (IAM), see: https://microcks.io/documentation/administrating/users/
• https://operatorframework.io/ For fully automated Kubernetes installation, see: https://microcks.io/documentation/installing/operator/
• Full life cycle management and GitOps ready (CRD) in the next release (ongoing rewrite using Quarkus)
• https://helm.sh/ For packaging Microcks for Kubernetes, see: https://microcks.io/documentation/installing/kubernetes/

Complement and interoperate with:

• https://backstage.io/ plugin for synchronizing Microcks content (APIs) for Backstage.io catalog, see: https://microcks.io/blog/backstage-integration-launch/
• https://tekton.dev/ tasks for integrating Microcks into a cloud-native pipeline, see: https://microcks.io/documentation/automating/tekton/
• https://cloudevents.io/ for simulating CloudEvents with AsyncAPI and Microcks, see:
  https://microcks.io/blog/simulating-cloudevents-with-asyncapi/ & recording of AsyncAPI Conference 2021

Cloud Native Overlap

As far as we are aware, no existing CNCF project overlaps with Microcks.

Similar projects

Elsewhere, yes we have some similar open source projects for mocking (Hoverfly, Keploy et Mockitosh...) or testing (Pact...) but no overlap (from what we are aware off) with tools covering both (mocking + testing) and with such a large multi-protocol and multi-specs as Microcks.

As we often have the question of "Microcks vs Pact for contract testing", we have written a blog post for this purpose to try to clarify similarities and differences between the two projects.
Please see: https://medium.com/@lbroudoux/microcks-and-pact-for-api-contract-testing-3e0e7d4516ca

Product or Service to Project separation

N/A

Project presentations

1st presentation to CNCF TAG App Delivery during pre-day meetup at KubeCon + CloudNativeCon Europe 2023, see:

• Slide deck (PDF / Google slide)
• Recording is available here: https://youtu.be/4xzklryIT7Q?t=10291

2nd presentation (2023-05-17) as a follow-up during TAG App Delivery bi-weekly meeting, see:

• CNCF TAG App Delivery Meeting Notes
• Slide deck (PDF / Google slide)
• The recording is available here (with a live demo): https://youtu.be/UnNozJiNcz8?t=1599

Project champions

Josh Gavant - Lead TAG App Delivery

Additional information

This testimonial from J.B Hunt. is good community user feedback regarding why Microcks and the productivities gains that were realized:
“
Accelerating development
The developers of the project mentioned above saved at least 7 months using Microcks. They were not only able to work concurrently but also captured the exact business requirements specified by the product owner in the form of example request/response pairs. These persistent mocks can now be utilized in sandbox environments if needed.
“
See for the full blog post:
https://microcks.io/blog/jb-hunt-mock-it-till-you-make-it/