Skip to main content

PUT API

Instructions to Test a PUT API in Data Equity Studio

Follow these steps to test a PUT API using Data Equity Studio.

1. Create the API Definition​

  • Define the API and ensure the data type is properly created.
  • Assign a mock data type to the resource type to enable automatic mock data generation.
  • Add the data type to the request body and response types for the API operation.

2. Create the PUT Path Definition​

  • The PUT API path will contain an identifier to identify the resource being updated. The Data Equity Studio allows parameterized values to be passed for such IDs.
  • In the Path Parameters section, you can select your data type and assign the field that corresponds to the selected ID. Docs Version Dropdown

3. 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. Docs Version Dropdown

4. Test the API Using Postman​

  • Open Postman or any API testing tool.
  • Use the Mock URL provided after deployment.
  • Set the HTTP method to PUT.
  • Include the resource ID in the URL to specify which resource to update.
  • Add a JSON payload in the request body to simulate updating an existing resource.
  • Send the request and observe the response. Docs Version Dropdown
  • A quick verification using a GET call will show the addition of the new data Docs Version Dropdown