1. API Studio: Overview for Developers

Updated 3 months ago by Rahul Lahiri

API Studio is a microservices API development tool that helps build, test and debug APIs, and create service tests for microservices APIs using auto-created mocks for upstream services.

Iteratively develop API requests & responses
  • Send requests to any REST or gRPC API endpoint
  • Compare responses against a baseline
  • Identify API behavior changes across time
Develop APIs with ingress-egress tracing
  • Send requests to the service running in your IDE
  • Get observability of API requests from your service to producer services
  • Forward egress requests from your service to live services or mocks
  • Create mocks for all producer (upstream) services
  • Compare responses against a baseline
  • Identify changes in the egress requests and responses
  • Share mocks of your service with other developers
Create service tests with auto-created API mocks

Service tests help test a service in isolation while mocking all producer services.

  • Create API mocks for producers automatically.
  • Run service tests locally in your laptop or in your CI
  • Share your service tests with other developers

We have included a sample application and a step-by-step guided tour of API Studio using the included demo application. Over the next few sections, we will explain how API Studio works, set up the sample application, and run a few requests to the sample application to introduce you to the capabilities of the API Studio.

Main Components

The system consists of 3 primary components:

  1. API Studio desktop app
  2. Mesh Dynamics back-end

API Studio desktop app

This is the application developers download and run on their laptops. We will go over the API Studio in detail in the next sections.

Mesh Dynamics back-end

The back-end stores all the data and provides automated mock services based on the captured data. The back-end can be hosted either by Mesh Dynamics or in your organization’s private VPC. Users do not have direct access to the back-end, but you need to know where it is hosted in order to configure the API Studio desktop app correctly. If the back-end is hosted in the Mesh Dynamics cloud, then you should have a seamless experience using the default configurations API Studio ships with. If it is hosted in your organization's VPC, then you would need to configure the default network address to enable the client to communicate with the back-end services.

Next steps

Let's get familiar with the main capabilities of API Studio desktop app.

How did we do?