org.jsondoc.core.annotation

Annotation Type ApiObject

@Documented
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface ApiObject

This annotation is to be used on your object classes and represents an object used for communication between clients and server

Author:

Fabio Maffioletti

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description A description of what the object contains or represents
String	group With this it is possible to specify the logical grouping of this object.
String	name The name of the object, to be referenced by other annotations with an "object" attribute
boolean	show Whether to build the json documentation for this object or not.

Element Detail

name

public abstract String name

The name of the object, to be referenced by other annotations with an "object" attribute

Returns:

See Also:

ApiBodyObject, ApiResponseObject

Default:

""

description

public abstract String description

A description of what the object contains or represents

Returns:

Default:

""

show

public abstract boolean show

Whether to build the json documentation for this object or not. Default value is true

Returns:

Default:

true

group

public abstract String group

With this it is possible to specify the logical grouping of this object. For example, if you have objects like "city", "country", "continent", "author" and "book", you can say that "city" "country" and "continent" are grouped in the "Geography" group, and "author" and "book" are grouped in the "Library" group.

Returns:

Default:

""