Getting started

On this page, you will go through :

Installing Microcks

Microcks may be installed in many ways depending your preferred environment. Basically, it can be installed using OpenShift, using Docker-Compose or directly using binary and source of Microcks.

Installing on OpenShift

The easiest way of installing Microcks for production use is to do it on OpenShift. OpenShift in version 3.6 or greater is required. It is assumed that you have some kind of OpenShift cluster instance running and available. This instance can take several forms depending on your environment and needs :

Then you have to ensure that Microcks templates for OpenShift are added and available into your Cluster. Templates come in 2 flavors: ephemeral or persistent. In persistent mode, template will claim a persistent volume during instanciation, such a volume should be available to your team / project on OpenShift cluster. Add the templates, by using these commands :
oc create -f -n openshift
oc create -f -n openshift

Once this is done can now create a new project and instanciate the template of your choice ; either using the OpenShift web console or the command line. You will need to fill up some parameters during creation such as:
  • the hostname for routes serving Microcks and embedded Keycloak (typically component_name-project-app_domain),
  • the URL for joining OpenShift Master,
  • a name for an OAuth Client that will be created apart the app creation.
Typically, you'll got this kind of commands for a local Minishift instance:

oc new-project microcks --display-name="Microcks"
oc new-app --template=microcks-persistent --param=OPENSHIFT_MASTER= --param=OPENSHIFT_OAUTH_CLIENT_NAME=microcks-client

After some minutes and components have been deployed, you should end up with a Spring-boot Pod, a MongoDB Pod, a Postman-runtime Pod, a Keycloak Pod and a PostgreSQL Pod like in the screenshot below.

Now you can retrieve the URL of the created route using oc get routes command and navigate to this URL to get started with Microcks. Depending on your environment, URL should be something like By default, Microcks integrates with OpenShift identity provider through the use of Keycloak but you may configure some other providers later.

Installing using Docker Compose

For those of you familiar with simple Docker Compose, a docker-compose</source> file is available within GitHub repository and can be used to rapidly test up things. First step is to download the file and then to execute docker-compose with local files copies like in this commands :

mkdir keycloak-realm && cd keycloak-realm && curl -o microcks-realm-sample.json && cd .. && curl -o microcks-mongodb.yml
docker-compose -f microcks-mongodb.yml up -d

After some minutes and components have been deployed, you should end up with a Spring-boot container, a MongoDB container, a Postman-runtime and a Keycloak container like in the trace below. The default user is admin with 123 password. The Microcks application is now available on http://localhost:8080 URL.

ยป docker ps
CONTAINER ID        IMAGE                                      COMMAND                  CREATED             STATUS              PORTS                    NAMES
6a563e9d87c1        microcks/microcks:latest                  "/bin/sh -c 'exec ..."   6 days ago          Up 33 seconds>8080/tcp   microcks
162e99a97a6f        microcks/microcks-postman-runtime:latest   "node app.js"            6 days ago          Up 39 seconds       3000/tcp                 microcks-postman-runtime
b3cb4840597b        mongo:3.3.12                               "/ mo..."   6 days ago          Up 39 seconds       27017/tcp                microcks-mongo
949e0b9bdac6        jboss/keycloak:3.4.0.Final                 "/opt/jboss/docker..."   6 days ago          Up 38 seconds>8080/tcp   microcks-keycloak

Building from binary/sources

To Do ...

Using Microcks

Now you are ready to use Microcks for deploying your own services and API mocks! Before that let's have the look at the application home screen and introduce the main concepts. Using the application URL after installation, we should land on this page with 2 main entry points : Services and Jobs.

As you may have guessed, Services is about browsing your [micro]-services and API repository, discovering and accessing documentation, mocks and tests. Jobs is another concept dedicated on how to fill this repository: it allows to periodically scan your Git or Subversion repository for checking new definition files that will be parsed and integrated as part of your [micro]-services and API repository. Indeed Jobs help discover new or modified Services. Before creating your own service definition files, let load some samples into Microcks for a test ride.

Loading samples

We provide different samples that illustrate different ways of creating service definitions. The 2 firsts are definition files realized using SoapUI and demonstrating SOAP and REST services. The third one is a definition file built using Postman and demonstrating the famous Petstore API. Using the Jobs entry point from home screen or top navigation bar, use the Job management page to add 3 new jobs. For each, you will be asked a name and a repository URL. Use the informations below:

  • Hello SOAP Service :
  • Hello REST API :
  • Petstore API :
Now that you have created your Jobs, you have to Activate them (this make them eligible to a periodically check) and to Start them (this make a forced refresh right now). After some moments and a page refresh, you should see the status of Jobs changed like in screenshot below:

Viewing services

Once sample jobs have been loaded, new Services has been discovered and added to your repository. You can now visit the Services entry point from top navigation bar or home screen. You should see 3 new services with basic informations on version and operations/resources handled by this services.

Viewing details

Now choosing the Petstore API microservice, you'll be able to access details, documentation and request/response samples for each operation/resource in the screen below. One important information here is the Mocks URL field: this is the endpoint where Microcks automatically deploy a mock for this operation. The table just below show request/response couples and a detailed URL with the HTTP verb showing how to invoke this mock.

Using this URL, you can call the exposed mock for Petstore API using the following curl command :

curl ""

And you should receive the following response :


Ta Dam !

What's next?

Now that you have basic information on how to setup and use Microcks, you can go further with :