Annotation Type RESTServiceParam


  • @Retention(RUNTIME)
    @Target(PARAMETER)
    public @interface RESTServiceParam
    REST service parameter annotation.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String desc
      Parameter description
      java.lang.String format
      Parameter format
      java.lang.String in
      In path or query?
      java.lang.String name
      Parameter name
      java.lang.String pattern
      Parameter pattern,
      boolean required
      Required?
      java.lang.String type
      Parameter type
    • Element Detail

      • name

        java.lang.String name
        Parameter name
        Returns:
        Name
        Default:
        ""
      • desc

        java.lang.String desc
        Parameter description
        Returns:
        Description
        Default:
        ""
      • type

        java.lang.String type
        Parameter type
        Returns:
        "string", "number" etc.
        Default:
        ""
      • format

        java.lang.String format
        Parameter format
        Returns:
        "binary", "byte" etc. aapplicable to "string" type
        Default:
        ""
      • pattern

        java.lang.String pattern
        Parameter pattern,
        Returns:
        Pattern, applicable to "string" type
        Default:
        ""
      • in

        java.lang.String in
        In path or query?
        Returns:
        "path" or "query"
        Default:
        "query"
      • required

        boolean required
        Required?
        Returns:
        True or false
        Default:
        false