What is API Studio?
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.
With API Studio you can:
- Send requests to the service running in your IDE
- Create virtual services (mocks) for all upstream (dependent) services
- Route outgoing requests from the service to live services or mocks
- Compare responses against a baseline
- Identify changes in the egress requests and responses
- Share mocks of your service with other developers
- Create service tests that can be run locally or in a CI pipeline
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.
The system consists of 3 primary components:
- API Studio desktop app
- 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.
The listeners (or agents) are optional components for API Studio deployments. Mesh Dynamics listeners can be deployed in the CI pipelines to collect API requests and responses and populate the API catalog. The advantage of deploying the listeners is that API data is collected continuously from trustworthy sources, providing engineers up-to-date examples of each API at all times. The data can be used as examples of requests being sent to the API (valuable for refactoring), or for providing up-to-date mocks for any upstream API that the developer's service needs to use. Agent deployments are part of the advanced deployments only, and not part of the self-serve tool.
Let's get familiar with the main capabilities of API Studio desktop app.