Lab 02 - API Mocking

Return to Workshop

Lab 2

API Mocking

Bring your APIs to life




Overview

When building and working with APIs, you often need to simulate the responses of the system before it has been fully completed. This is what we explore in this workshop - mocking up API structures quickly so they can be subjected to testing without having to create all the final service code.

Why Red Hat?

Red hat combines and number of commercial and Open Source tools to cover each part of the API Design lifecycle. In this lab we'll be using the Microcks open source tool.

Lab Instructions

Step 1: Create a Microcks Job

  1. Open a browser window and navigate to microcks. Please ask your instructor if you need the link.

  2. Log in into Microcks using your designated user and password.




  3. You are now in the main Microcks page. Click the Importers button to access the Importers page.




  4. Click the Upload button to upload the Locations-UserX.yaml spec generated from Lab 1.




  5. Click on Upload.




Congratulations! The spec is successfully imported

  1. Navigate to APIs | Services tab.




  2. Click on the link for your username. eg: Locations-User1.




  3. Click on the arrow to expand the Operation GET /locations.




  4. You can check that the example we added to the definition in Lab 1 will be used to return the mock values. Copy and save the Mocks URL, we will use that endpoint to test the REST mock service.




Step 2: Test the REST Mock Service

We now have a working REST mock service listening for requests. We will use an online cURL tool to test it.

  1. Open a browser window and navigate to:

    https://onlinecurl.com/
    
  2. Enter the copied URL from Step 9. It should look similar to this:

    http://microcks.apps.ocp-ai.redhatgov.io/rest/Locations-User1/1.0.0/locations
    
  3. Click the START YOUR CURL button.




  4. The page will load the response information from the service. You will be able to see the RESPONSE HEADERS and the actual RESPONSE_BODY. This last part contains the examples we add during the design phase.




Congratulations! You have successfully configure a Microcks Job to create a REST mock service to test your API.

Summary

In this lab you used Microcks to configure a REST mock service for the API definition you created in the previous lab. REST mock services allows you to simulate a REST API service when you are in a prototyping stage of your API program journey.

Microcks allows you to test a number of various responses for client application requests. When deploying API, micro-services or SOA practices at large scale, Microcks solves the problems of providing and sharing consistent documentation and mocks to the involved teams. It acts as a central repository and server that can be used for browsing but also by your Continuous Integration builds or pipelines.

Notes and Further Reading

Return to Workshop