Package io.muserver.rest

Annotation Type ResponseHeader

  • @Target(METHOD)
@Retention(RUNTIME)
public @interface ResponseHeader
    Describes an HTTP Header that is returned by a rest method.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name
      The header name.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean deprecated
      Marks this header as deprecated to indicate that this header should no longer be used by clients.
      java.lang.String description
      A brief description of the header.
      java.lang.String example
      An example of a value that will be returned

    • Element Detail

      • name

        java.lang.String name
        The header name.
        Returns:
        name

      • description

        java.lang.String description
        A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
        Returns:
        description
        Default:
        ""

      • deprecated

        boolean deprecated
        Marks this header as deprecated to indicate that this header should no longer be used by clients.
        Returns:
        True if deprecated
        Default:
        false

      • example

        java.lang.String example
        An example of a value that will be returned
        Returns:
        The example
        Default:
        ""