net.ozwolf.raml.annotations

Annotation Type RamlApp

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface RamlApp

RAML App Annotation

This annotation is used to provide the overall description of an application.

This is effectively the root document of the RAML specification.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	baseUri The base URI of the application
String	title The title of the RAML application

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description The description of the application’s purpose.
RamlDocumentation[]	documentation References to application documentation.
RamlResponse[]	globalResponses Define global response definitions.
String[]	protocols The protocols the application can be accessed under (eg.
RamlSecurityScheme[]	security The security schemes the application supports.
RamlTrait[]	traits The global traits of the application.

Element Detail

title

public abstract String title

The title of the RAML application

Returns:

the application title

baseUri

public abstract String baseUri

The base URI of the application

Returns:

the application base URI

description

public abstract String description

The description of the application’s purpose.

Returns:

the application description

Default:

""

protocols

public abstract String[] protocols

The protocols the application can be accessed under (eg. HTTP, HTTPS, etc)

Returns:

the list of accessible protocols

Default:

"HTTPS"

documentation

public abstract RamlDocumentation[] documentation

References to application documentation.

This documentation is used to provide a general overview of functionality to support the service.

Documentation can be in the form of Markdown.

Returns:

the application documentation.

Default:

{}

security

public abstract RamlSecurityScheme[] security

The security schemes the application supports.

Can be used in conjunction with the @RamlSecuredBy annotation on resource methods to document resource security requirements.

Returns:

the application’s security schemes

Default:

{}

traits

public abstract RamlTrait[] traits

The global traits of the application. Can include descriptions of common request headers and query parameters as well as re-useable descriptors of responses.

Returns:

the application’s traits

Default:

{}

globalResponses

public abstract RamlResponse[] globalResponses

Define global response definitions. If a resource method does not explicitly define the status code of one of these responses, it will automatically be added.

Returns:

the default response definitions

Default:

{}