模块 org.redkale

注释类型 RestBody


  • @Documented
    @Target({PARAMETER,FIELD})
    @Retention(RUNTIME)
    public @interface RestBody
    只能注解于RestService类的方法的String/byte[]/JavaBean参数或参数内的String/byte[]/JavaBean字段

    用于获取HTTP请求端的请求内容UTF-8编码字符串、byte[]、JavaBean

    详情见: https://redkale.org

    作者:
    zhangjx
    • 可选元素概要

      可选元素 
      修饰符和类型 可选元素 说明
      String comment
      备注描述, 对应@HttpParam.comment
      String example
      for OpenAPI Specification 3.1.0
      boolean required
      参数是否必传, 框架运行中不作验证, only for OpenAPI Specification 3
    • 元素详细资料

      • required

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

        String example
        for OpenAPI Specification 3.1.0
        返回:
        String
        默认值:
        ""
      • comment

        String comment
        备注描述, 对应@HttpParam.comment
        返回:
        String
        默认值:
        ""