org.jsondoc.core.annotation

Annotation Type Api

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

This annotation is to be used on your "service" class, for example controller classes in Spring MVC.

Author:

Fabio Maffioletti

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description A description of what the API does
String	name The name of the API

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	group With this it is possible to specify the logical grouping of this API.
ApiStage	stage Indicates the stage of development or release
ApiVisibility	visibility Indicates the visibility of the api

Element Detail

description

public abstract String description

A description of what the API does

Returns:

name

public abstract String name

The name of the API

Returns:

group

public abstract String group

With this it is possible to specify the logical grouping of this API. For example, if you have APIs like city services or country services, you can group them in the "Geography" group, while if you have author services and book services you can group them in the "Library" group.

Returns:

Default:

""

visibility

public abstract ApiVisibility visibility

Indicates the visibility of the api

Returns:

Default:

org.jsondoc.core.pojo.ApiVisibility.UNDEFINED

stage

public abstract ApiStage stage

Indicates the stage of development or release

Returns:

Default:

org.jsondoc.core.pojo.ApiStage.UNDEFINED