Common parameters

In API development, maintaining consistency across endpoints is critical. Apidog addresses this by offering the Common Parameters feature, which allows for the reuse of parameters with identical names and descriptions across different endpoints.

Configure common parameters

To modify or set up your common parameters, follow these steps:

Access Parameter Settings

Click on the menu button located on the Description section within the endpoint spec interface.

Alternatively, you can manage common parameters under Settings - Project Resources - Common Parameters.

Enter Details

Type in the parameter name, description, and any other necessary information.

Save the Parameter

Confirm your entries by clicking on the "Save" button.

Import / Bulk Edit

Supports importing or bulk editing commonly used parameters using either comma or colon as separators.

Utilizing Common Parameters

When entering parameter names in an endpoint, you will be presented with pre-defined Common Parameters for selection. Choosing a Common Parameter will automatically populate its Description.

Configure common parameters#

Import / Bulk Edit#

Utilizing Common Parameters#

Configure common parameters

Import / Bulk Edit

Utilizing Common Parameters