Skip to main content

API Unique Identification

Currently, most APIs are differentiated based on the method and path. However, some development projects (such as some e-commerce API documents) use a fixed URL for the API request and differentiate between APIs using parameters in the Query / Header.

After version 2.2.9, Apidog added the API Unique Identification feature, which supports operationId, Query parameters, Body parameters, and Header parameters as parameters to differentiate between APIs.

1. Setting API Unique Identification​

API Unique ID is defined as a set at the directory level. When you need to set an API as a unique identification, you need to set it in its parent directory. Choose the unique identification parameter you need according to your needs, and after clicking save, it will take effect on all APIs under that directory.

Example: An e-commerce API API uses the action parameter in the Query parameter as the parameter for the Unique API ID. After selecting theQuery parameter in the figure below, enter the corresponding parameter name in the input box on the right.

2. Fill in the corresponding Parameter Value for the Unique Identifier​

After setting the Unique API Identification for the directory, click on an API under that directory, click the operationid tab, and in both the basic information and request parameters at the bottom of the API, there is an icon of K, which represents the parameter for the Unique API ID.

You can enter the corresponding value under the corresponding parameter as the value for the Unique API Identification.

3. Display the Unique Identifier on the Document Page​

After filling in the value for the Unique API Identification on the Edit page of the API, it will be displayed as shown below on the Documents page and in the Online Documentation.

adada

4. Import​

If you use parameters in Query/Header to distinguish between APIs in your project and import an Openformatted file into Apidog, the following page will appear.

The rule for matching APIs during import is subject to the settings of the target directory. If the setting of the Unique API Identification in the target directory does not meet the requirements, you can modify it in the import settings. After modification, it will take effect directly on the target directory

Example: An e-commerce API API uses the action parameter in the Query parameter as the parameter for the Unique API Identification On the following page, click Edit to modify the Unique API Identification when importing Apidog.

adada

tip

  1. Users who have used the Fixed Value in Query parameters need not worry because this function will still be retained. However, when importing, the Fixed Value is judged based on the URL, so it is recommended that users who have used the Fixed Value use the Unique API Identification.

  2. The Unique API Identification supports setting multiple parameters.

  3. If only a subdirectory in your directory is set as the Unique API Identification, when importing Swagger and updating all directories, please avoid importing all projects to the root directory for updating. It is recommended to import APIs set as Unique API Identification separately into that special.

5. Mock Data​

Starting from version 2.2.24, if the API has set the unique identifier as Body Parameter or Header Parameter, you need to send the path + parameter name and value of the unique identifier to get the corresponding Mock Data.

tip
  1. When accessing Mock Data during development, frontend developers also need to send the path + parameter name and value of the unique identifier if the API has set the unique identifier as Body Parameter or Header Parameter.
  2. For projects that have a unique identifier for APIs, the API documentation needs to be standardized to avoid cases where APIs have the same URL but do not have a unique identifier set. This is to avoid the failure of obtaining Mock Data correctly.