Front-end development using API mocks
Mesh Dynamics supports parallel front-end and back-end API development using back-end API mocks. Mocks for back-end APIs can be created using API Studio, and the mocks can be used to respond to API requests generated by the front-end during development.
- The application front-end is running locally on the developer's laptop.
- API Studio is also running on the developer's laptop.
- API requests from the front-end (running in the developer's laptop) should be sent to the local API Studio proxy port. The default proxy port for sending the requests from the front-end is localhost:9000.
- API Studio will intercept the requests, fetch the best matching response from the Mesh Dynamics back-end, and return the response to the front-end.
API Studio proxy port
API Studio proxy listens to the traffic coming into a localhost port. The default port is port 9000. If you have other services using that port, you can change the API Studio configuration to listen to a different port. To change the port configuration, follow the steps below.
- Open the API Studio configuration menu.
- Select the Settings menu item.
- Set the port you want API Studio to use for listening to incoming requests, and click Save. You should send the requests from the front-end to this port.
- Click on the Back button to get back to the API editor.
Sending requests to API Studio
The front-end must be running locally on the developer’s laptop to leverage the API mocking capabilities of API Studio described here.
The requests from the front-end must be sent to the localhost port where the API Studio proxy is configured to listen to. The default API Studio proxy port is 9000. The front-end must always send the requests to the API Studio proxy using a URL of the form:
We will use the normalized format URL we created earlier for example. The process is the same if you prefer to retain the original captured URL. Functionally there is no difference between the two formats. Using the simplified format makes it a little easier to maintain if you are using mocks extensively.
Request using normalized URL format
During front-end development, the request should be sent to the API Studio proxy. Here we will issue the request from the API Studio itself. However, the request is exactly the same regardless of whether it is issued from the front-end or from the API Studio.
The advantage of using this format is that it is easy to understand and maintain. However you have to convert the captured url to this format.
Sending this request from the API Studio gets this response:
Using captured URL
If you prefer to use the mocks from the capture without modifying the URL, this is the request URL to mock server:
Sending this request from the API Studio gets the same response as above: