模块 org.redkale

注释类型 HttpParam


  • @Documented
    @Target(METHOD)
    @Retention(RUNTIME)
    @Repeatable(HttpParams.class)
    public @interface HttpParam
    配合 @HttpMapping 使用。 用于对@HttpMapping方法中参数描述
    从RestService生成过来的HttpMapping,标记为@RestUserid、@RestAddress、@RestLocale的参数不会生成HttpParam

    详情见: https://redkale.org

    作者:
    zhangjx
    • 必需元素概要

      所需元素 
      修饰符和类型 必需的元素 说明
      String name
      参数名
      Class type
      参数的数据类型
    • 可选元素概要

      可选元素 
      修饰符和类型 可选元素 说明
      String comment
      备注描述
      boolean deprecated
      是否过期字段, only for OpenAPI Specification 3
      String example
      for OpenAPI Specification 3
      int radix
      转换数字byte/short/int/long时所用的进制数, 默认10进制
      boolean required
      参数是否必传, 框架运行中不作验证, only for OpenAPI Specification 3
      HttpParam.HttpParameterStyle style
      参数来源类型
      String typeref
      参数的泛型数据类型在HttpServlet里的字段名,且字段类型必须是 java.lang.reflect.Type
      如果参数数据类型不是泛型,则值为空
    • 元素详细资料

      • name

        String name
        参数名
        返回:
        String
      • type

        Class type
        参数的数据类型
        返回:
        Class
      • typeref

        String typeref
        参数的泛型数据类型在HttpServlet里的字段名,且字段类型必须是 java.lang.reflect.Type
        如果参数数据类型不是泛型,则值为空
        返回:
        String
        从以下版本开始:
        2.5.0
        默认值:
        ""
      • comment

        String comment
        备注描述
        返回:
        String
        默认值:
        ""
      • style

        HttpParam.HttpParameterStyle style
        参数来源类型
        返回:
        HttpParameterStyle
        默认值:
        org.redkale.net.http.HttpParam.HttpParameterStyle.QUERY
      • radix

        int radix
        转换数字byte/short/int/long时所用的进制数, 默认10进制
        返回:
        int
        默认值:
        10
      • required

        boolean required
        参数是否必传, 框架运行中不作验证, only for OpenAPI Specification 3
        返回:
        boolean
        默认值:
        true
      • deprecated

        boolean deprecated
        是否过期字段, only for OpenAPI Specification 3
        返回:
        boolean
        默认值:
        false
      • example

        String example
        for OpenAPI Specification 3
        返回:
        String
        默认值:
        ""