Annotation Type ApiHeader


@Target({FIELD,METHOD}) @Retention(RUNTIME) public @interface ApiHeader
Annotation for defining headers to be set in the response to read requests for the Resource described by the model. Can be used on a public field or method. The return type must be a String, iterator of strings, or a collection of strings that is iterable. If a method is annotated and it takes in a ConverterContext in order to get information from the request that will be injected into the method.
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    The header's key
  • Element Details

    • value

      String value
      The header's key
      Returns:
      the header's key