org.projectodd.jrapidoc.annotation.rest

Annotation Type DocPathExample

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

Annotatation can be used on resource class and resource method
Because javax.ws.rs.Path.value can contain regular expressions which are not much readable, here can be placed example of path.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Because javax.ws.rs.Path.value can contain regular expressions which are not much readable, here can be placed example of path.

Element Detail

value

public abstract String value

Because javax.ws.rs.Path.value can contain regular expressions which are not much readable, here can be placed example of path.

Returns: