net.ozwolf.raml.annotations

Annotation Type RamlExample

@Retention(value=RUNTIME)
 @Target(value={METHOD,PARAMETER,TYPE})
public @interface RamlExample

RAML Example Annotation

This annotation can be used to:

• 1. Used to annotate a request or response class, with the value either referencing a classpath file or containing specific contents.
• 2. Annotate a static method on a request or response class that generates an example instance of that class.
• 3. Used to annotate a header or query parameter in a method to provide an example.

This annotation on a type will trump the annotation on the static method.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	value An example value.

Element Detail

value

public abstract String value

An example value. Can either be a raw value or reference a classpath example file (for request/response classes).

This is ignored when the annotation is used in conjunction with an example static method.

Returns:

the example value

Default:

""