PATCH API
Instructions to Test a PATCH
API in Data Equity Studio
Follow these steps to test a PATCH API using Data Equity Studio.
1. Create the API Definition
- Define the API and ensure the resource type is properly created.
- Configure the PATCH operation for the resource.
- Ensure the API accepts an ID parameter in the URL to specify which resource should be partially updated.
- Assign a mock data type to the resource type to enable automatic mock data generation.
2. Deploy the API
- Navigate to the Policy Editor.
- Configure any required policies (e.g., API Key authentication, rate limiting).
- Click Deploy API to make your mock API available.
3. Test the API Using Postman
- Open Postman or any API testing tool.
- Use the Mock URL provided after deployment.
- Set the HTTP method to PATCH.
- Include the resource ID in the request URL to specify which resource to update.
- Add a JSON payload in the request body to update only the necessary fields.
- Send the request and observe the response.
- A quick verification using a GET call will show the addition of the new data