Descriptions

提示

Filling in parameter descriptions can be a tedious task, especially when many interfaces have parameters with the same name and meaning. Manually entering them each time is both time-consuming and inefficient. The parameter description library offers a solution to this problem.

How to Use the Parameter Description Library

You can predefine common parameter descriptions in the parameter description library. For example, common parameters might include:

{
    "name": "user name ",
    "age": "user age",
    "email": "user email， Commonly used for login",
    "school": "user school"
}

When a predefined parameter name is used, the corresponding description will automatically populate, eliminating the need for manual entry. If multiple descriptions exist for the same parameter, you can select one from the dropdown menu.

The system also includes a batch of built-in parameter descriptions, which you can enable with a simple toggle.

Maintaining the Parameter Description Library

To enhance development efficiency, there are two ways to maintain the parameter description library

Automatic Extraction of Descriptions

During daily interface design or debugging, any parameter descriptions entered are automatically extracted and temporarily stored in the parameter description library.
Temporarily stored data will be lost when the page is refreshed. Be sure to click Save to make the data permanent.

Importing Parameter Descriptions

提示

For the Key-Value format, use a colon (:) to separate keys and values (e.g.,name: John Doe), and use line breaks to separate multiple records.

For the Raw-JSON format, use standard JSON syntax, for example: {"name": "John Doe", "age": 1}

//key-value example
name: User's real name
age: User age
email: User email
school: School

//raw-json example
{
    "name": "User Name",
    "age": "User Age",
    "email": "User Email",
    "school": "School"
}