文档将说明API参数的校验规则 , 传递规则以及部分注意事项 , 意在明确什么样的参数是合法的 , 避免歧义以及降低开发成本 .
API定义中的 基础 数据类型对应Java语言中的数据类型 , 其中包括Integer , Short , Float/Double , String , List , Map . 另外有其他对象类型 , 具体参见不同API的 DataType 部分 .
API中如果定义为int型 , 且有范围限制 , 比如:有变量a , 它的范围是:1-255 , 那么赋值 a: 1 , a: “1” , 均 可以 生效 , API首先需要保证正确的值类型和取值范围内的赋值 , 处理成功 , 取值范围以外 , 如果通过简单的类型转换 , 可以变换成取值范围内的值 , API可以 选择性 给予支持 , 像上面的例子 , 就是”1”可以简单的转换为1 , 反之 , 如果有变量限制值为str型 , 比如:有变量a , 那么赋值 a: “1” , a: 1 , 均 可以 生效 , 因为1可以简单的转换为 “1” .
参数内容部合法的异常处理 , 比如:当参数类型和长度合法 , 但是内容不合法时 , 参数a , str型 , 长度:1-63 , 但是a在赋值时 , 包含非法值 “a”: ”?{}123” , 此时会出现系统级异常 , 不能正确进行识别 , 需要开发者进行正确性检查 .
在不恰当的位置使用中文 , 或者特殊符号等 , 被浏览器 , 测试工具 , apache等限制 , 认为非法地址而阻断的 , 不是服务支持的缺陷 .
一些在取值范围以外的 , 特