Getting started

Quickstart

The easiest way to get started is using Docker Compose to start the minimal requirements. Make sure you have Docker installed on your system.

In your terminal issue the following commands:

  1. Clone this repository.

    git clone https://github.com/microcks/microcks.git
    
  2. Change to the install folder

    cd microcks/install/docker-compose
    
  3. Spin up the containers

    docker-compose up -d
    

This will start the required containers and setup an simple environment for your usage.

Open a new browser tab and point to the http://localhost:8080 endpoint. This will redirect you to the Keycloak Single Sign On page for login. Use the following default credentials to login into the application:

  • Username: admin
  • Password: 123

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, API | Services is about browsing your [micro]-services and API repository, discovering and accessing documentation, mocks and tests. Importers is another concept dedicated on how to fill this repository: it allows to define Jobs 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 Importers 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. The fourth one is an OpenAPI v3 specification file and present the advantages of holding both the contract specification and the examples. The Last one is an AsyncAPI v2 specification file - AsyncAPI being a new specification format dedicated to asychronous and event-oriented APIs. Using the Importers entry point from home screen or left navigation bar, use the Importers management page to add 5 new jobs. For each, you will be asked a name and a repository URL. Use the informations below:

  • Hello SOAP Service : https://raw.githubusercontent.com/microcks/microcks/master/samples/HelloService-soapui-project.xml
  • Hello REST API : https://raw.githubusercontent.com/microcks/microcks/master/samples/HelloAPI-soapui-project.xml
  • Petstore API : https://raw.githubusercontent.com/microcks/microcks/master/samples/PetstoreAPI-collection.json
  • Pastry API : https://raw.githubusercontent.com/microcks/microcks/master/samples/APIPastry-openapi.yaml
  • User signed-up API : https://raw.githubusercontent.com/microcks/microcks/master/samples/UserSignedUpAPI-asyncapi.yml

Now that you have created your Jobs, they are automatically Activated (this make them eligible to a periodically check) and to Imported (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 API | Services entry point from top navigation bar or home screen. You should see 5 new services with basic informations on version and operations/resources handled by this services.

sample-services

Viewing details

Now choosing the Petstore API REST API, 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.

sample-details

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

$ curl "http://microcks.192.168.64.7.nip.io/rest/Petstore+API/1.0/pet/findByStatus?status=available&user_key=70f735676ec46351c6699c4bb767878a"

And you should receive the following response:

[{"id":190192062,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"},{"id":190192063,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"},{"id":190192285,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"},{"id":190192654,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"},{"id":190192671,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"},{"id":190192727,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"},{"id":190192736,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"},{"id":190192768,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"},{"id":190192878,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"},{"id":190192907,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"},{"id":190193000,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"},{"id":-98125093,"category":{"id":-517488397,"name":"EJvNbK"},"name":"LuEfMZATrHz","photoUrls":["XCXOVVkaxa","gNwYqHEmC","nvCvphDeuqztysUBNed","W","vmrxRIViyXqumolLIeoB","JRqHVxk","tCUGbegVHoXajm","UiHppQn"],"tags":[{"id":727599428,"name":"RemggEDzxPljbrlktdWf"},{"id":1987753751,"name":"zWqdKAGHMmhPPlomljaNtuvm"},{"id":1251632392,"name":"BAgtgtKOxZGdsS"},{"id":-1813025208,"name":"OkKxtfAkCMEICbbQDVPi"},{"id":-730110346,"name":"WshDF"},{"id":2100951153,"name":"yxUFSknQEleIAQCoocl"},{"id":-2135188117,"name":"M"},{"id":1352243140,"name":"koKHsjysHXW"},{"id":1696778814,"name":"KaihiyarcZkIzkkquWPZ"},{"id":659492963,"name":"xqIzulcBPzWMyUpQwQK"},{"id":-2118372841,"name":"naYFGuHmqDqOpfHH"}],"status":"available"},{"id":8739826599258110549,"category":{"id":0,"name":"string"},"name":"doggie","photoUrls":["string"],"tags":[{"id":0,"name":"string"}],"status":"available"}]

Ta Dam !

Installing Microcks

If you require a more complex installation, Microcks may be installed in many ways depending your preferred environment. Basically, it can be installed on Kubernetes, on OpenShift, using Docker-Compose or directly using binary and source of Microcks.

Installing with Kubernetes Operator

We provide an Operator that is distributed through OperatorHub.io for easy install and management of Microcks as a Kubernetes-native application.

Have a look on this page for more informations.

Installing on Kubernetes with Helm

We provide a Helm 3 Chart for using with Helm Packet Manager. This is definitely the preferred way of installing apps on Kubernetes.

Have a look on this page for more informations.

Installing using Docker Compose

Docker Compose is really easy for a laptop or single demonstration server. You’ll find instructions on how to use Docker Compose for installation here.

Quick installation in Azure

We provide this sub project microcks/microcks-azure for easily setting up a one-click deployment to Microsoft Azure Cloud.

What’s next?

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

“Getting started” was last updated: September 1, 2019
Improve this page