Common fields

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

Configure common fields

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

Access Field Settings

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

Alternatively, you can manage common fields under Settings - Project Resources - Common Fields.

Enter Details

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

Save the Field

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

Import / Bulk Edit

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

Utilizing Common Fields

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

Configure common fields#

Import / Bulk Edit#

Utilizing Common Fields#

Configure common fields

Import / Bulk Edit

Utilizing Common Fields