org.restdoc.annotations

Annotation Type RestDocType

@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface RestDocType

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	type

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	schema
Class<?>	schemaClass

Element Detail

type

public abstract String type

Returns:

the response type e.g. text/plain or application/json

schema

public abstract String schema

Returns:

the schema URI

Default:

""

schemaClass

public abstract Class<?> schemaClass

Returns:

the schema Class

Default:

java.lang.Object.class