Web

通用接口校验说明

更新时间: 2024/03/14 19:21:10

通用接口校验说明

API 调用的过程中,可能会遇到如下入参校验错误:

jsawait qchat.qchatRole.createServerRole({
  "serverId": "1377422",
  "name": "gamer1111",
  "priority": 9
})

// TypeError: param "serverId" expects {"type":"string","allowEmpty":false}

您可参考如下校验规则完成入参校验。

String 类型入参校验规则

校验规则 说明 默认值
Required 是否必须填 true
min 最小字符长度 无默认值
max 最大字符长度 无默认值
allowEmpty 是否允许空字符串输入 true

number 类型入参校验规则

校验规则 说明 默认值
Required 是否必须填 true
min 最小数字 无默认值
max 最大数字 无默认值

boolean 类型入参校验规则

校验规则 说明 默认值
Required 是否必须填 true

enum 类型入参校验规则

校验规则 说明 默认值
Required 是否必须填 true
values 允许的输入范围 无默认值

array 类型入参校验规则

校验规则 说明 默认值
Required 是否必须填 true
min 最小数组长度 无默认值
max 最大数组长度 无默认值
itemType 数组中每一项的校验类型 无默认值
rules 嵌套规则 无默认值

object 类型入参校验规则

校验规则 说明 默认值
Required 是否必须填 true
rules 嵌套规则 无默认值
此文档是否对你有帮助?
有帮助
去反馈
  • String 类型入参校验规则
  • number 类型入参校验规则
  • boolean 类型入参校验规则
  • enum 类型入参校验规则
  • array 类型入参校验规则
  • object 类型入参校验规则