Path Variables in Client Requests

Overview

Path variables are placeholders within API endpoints that can be dynamically replaced with actual values at runtime. This feature is crucial when making requests to endpoints that require specific parameters in their paths.

Using Path Variables in Twidget

When you select an endpoint with path variables (denoted by {}), Twidget's API client builder will automatically detect these placeholders and facilitate their management through a dedicated section.

Steps to Utilize Path Variables

1. Select an Endpoint: Choose an API endpoint that includes one or more path variables. For example: /users/{userId}/posts/{postId}.

2. Open the Path Variable Section: Upon selecting the endpoint, a new section in the API client builder will appear. This section is specifically designed for entering the values for your path variables.

   

3. Enter Variable Values:

   • Locate the input fields corresponding to each path variable.

   • Enter the values for each variable. For example, if your endpoint is /users/{userId}/posts/{postId}, you would input specific values for userId and postId.

4. Automatic Replacement: The values entered in the path variable fields will replace the placeholders in your endpoint path when the API request is sent.

Manual Path Entry

If you prefer, Twidget allows you to manually enter the full path without using the path variable feature. This is useful for scenarios where you may have a complete path available or do not need dynamic replacements.

• Simply input the entire endpoint directly into the path field, bypassing the path variable section. For example, enter /users/66d9fe/posts/66d9fe directly if userId is 66d9fe and postId is 3b7f3c70.

Benefits

• Flexibility: Both dynamic and static path entries are supported, providing flexibility based on your needs.

• Efficiency: Automates the replacement process, reducing the risk of human error in constructing paths.

• User-friendly: Intuitive interface for managing path variable values.