跳到主要内容

参数描述库

提示

填写参数描述是我们最烦恼的一件事情，尤其对于很多接口来说，往往具有大量相同名称、相同意义的参数，假如每次都需要手动录入，将会是一件非常耗时、低效的事情。我们可以通过参数描述库解决这个问题。

image.png

参数描述库是怎样使用的​

我们可以提前在参数描述库内写入常用的参数描述，例如以下这些常用参数

{
    "name": "用户姓名",
    "age": "用户年龄",
    "email": "用户邮箱",
    "school": "学校"
}

image.png

在具体使用到这个参数名时，就会自动填充提前定义好的参数描述，不需要再手动填写，如果同一个参数有多个参数描述也可以下拉选择填充

image.png

同时我们还提供了系统内置的一批参数描述，只需打开开关就可以使用了

image.png

如何维护​

为了提高开发效率我们提供了两种方式用于维护参数描述库

自动提取描述​

我们在日常设计接口或者调试接口时，填写的所有参数的描述内容，都会自动提取到参数描述库，并且存储为临时状态。

临时存储的数据刷新页面就会丢失，需要点击保存才会变为永久。

image.png image.png

导入参数描述​

提示

Key-Value格式使用英文冒号(:)分割,例如:name:张三,多条记录通过换行分割
Raw-Json格式使用标准的Json语法,例如:{"name":"张三","age":1(2)}

//key-value 示例
name:用户的真实名称
age:用户年龄
email:用户邮箱
school:学校

//raw-json 示例
{
    "name": "用户姓名",
    "age": "用户年龄",
    "email": "用户邮箱",
    "school": "学校"
}

image.png