开发者社区 问答 正文

RequestParameter是什么?



描述


前端入参信息项的类型

节点名


RequestParameter

子节点


名称类型描述
ApiParameterNameString参数名
LocationString参数位置,取值为:BODY、HEAD、QUERY、PATH
ParameterTypeString参数类型,取值为:String、Int、Long、Float、Double、Boolean,分别表示字符、整型、长整型、单精度浮点型、双精度浮点型、布尔
RequiredString是否必填,取值为:REQUIRED、OPTIONAL,分别表示必填、不必填
DefaultValueString默认值
DemoValueString示例
MaxValueLong当ParameterType=Int、Long、Float、Double,参数的最大值限定
MinValueLong当ParameterType=Int、Long、Float、Double,参数的最小值限定
MaxLengthLong当ParameterType=String,参数的最大长度限定
MinLengthLong当ParameterType=String,参数的最小长度限定
RegularExpressionString当ParameterType=String,参数验证(正则表达式)
JsonSchemeString当ParameterType=String,JSON验证(Json Scheme)
EnumValueString当ParameterType=Int、Long、Float、Double或String,允许输入的散列值,不同的值用英文的逗号分隔,形如:1,2,3,4,9或A,B,C,E,F
DocShowString文档可见,取值为:PUBLIC、PRIVATE
[tr=rgb(239, 251, 255)][td]DocOrder Integer文档中顺序 DescriptionString参数描述

展开
收起
轩墨 2017-10-26 15:08:12 2716 分享 版权
阿里云 AI 助理回答

前端入参信息项的类型详细定义如下,这些参数用于描述API接口接收前端请求时的各项参数规格:

  • 节点名: 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/MinValue: 当 ParameterTypeIntLongFloatDouble 时存在,类型为 Long,分别限制参数的最大值和最小值。
    • MaxLength/MinLength: 当 ParameterTypeString 时存在,类型为 Long,限定字符串参数的最大长度和最小长度。
    • RegularExpression: 类型为 String,仅对 String 类型参数有效,用于正则表达式验证参数格式。
    • JsonScheme: 类型为 String,针对 String 类型参数,提供JSON格式验证方案。
    • EnumValue: 类型为 String,适用于 IntLongFloatDoubleString 类型参数,列出了允许的枚举值,各值以英文逗号分隔。
    • DocShow: 类型为 String,决定参数在文档中的可见性,取值为 PUBLIC(公开)或 PRIVATE(私有)。
    • DocOrder: 类型为 Integer,指示参数在文档中的展示顺序。
    • Description: 类型为 String,对参数功能和用途的描述。

以上信息确保了API设计者能够详细规范每个前端传入参数的特性与要求。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答
问答分类:
问答地址: