描述
前端入参信息项的类型
节点名
RequestParameter
子节点
名称 | 类型 | 描述 |
ApiParameterName | String | 参数名 |
Location | String | 参数位置,取值为:BODY、HEAD、QUERY、PATH |
ParameterType | String | 参数类型,取值为:String、Int、Long、Float、Double、Boolean,分别表示字符、整型、长整型、单精度浮点型、双精度浮点型、布尔 |
Required | String | 是否必填,取值为:REQUIRED、OPTIONAL,分别表示必填、不必填 |
DefaultValue | String | 默认值 |
DemoValue | String | 示例 |
MaxValue | Long | 当ParameterType=Int、Long、Float、Double,参数的最大值限定 |
MinValue | Long | 当ParameterType=Int、Long、Float、Double,参数的最小值限定 |
MaxLength | Long | 当ParameterType=String,参数的最大长度限定 |
MinLength | Long | 当ParameterType=String,参数的最小长度限定 |
RegularExpression | String | 当ParameterType=String,参数验证(正则表达式) |
JsonScheme | String | 当ParameterType=String,JSON验证(Json Scheme) |
EnumValue | String | 当ParameterType=Int、Long、Float、Double或String,允许输入的散列值,不同的值用英文的逗号分隔,形如:1,2,3,4,9或A,B,C,E,F |
DocShow | String | 文档可见,取值为:PUBLIC、PRIVATE |
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
前端入参信息项的类型详细定义如下,这些参数用于描述API接口接收前端请求时的各项参数规格:
节点名: RequestParameter
子节点详情:
BODY
(请求体)、HEAD
(头部)、QUERY
(查询字符串)、PATH
(路径)。String
(字符)、Int
(整型)、Long
(长整型)、Float
(单精度浮点型)、Double
(双精度浮点型)、Boolean
(布尔)。REQUIRED
表示必填,OPTIONAL
表示可选。ParameterType
为 Int
、Long
、Float
或 Double
时存在,类型为 Long,分别限制参数的最大值和最小值。ParameterType
为 String
时存在,类型为 Long,限定字符串参数的最大长度和最小长度。String
类型参数有效,用于正则表达式验证参数格式。String
类型参数,提供JSON格式验证方案。Int
、Long
、Float
、Double
或 String
类型参数,列出了允许的枚举值,各值以英文逗号分隔。PUBLIC
(公开)或 PRIVATE
(私有)。以上信息确保了API设计者能够详细规范每个前端传入参数的特性与要求。