com.wordnik.swagger.annotations
Annotation Type Api

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

Required Element Summary

String

value Short description of the class

Optional Element Summary

String	basePath The base path that is prepended to all @Path elements.
String	description General description of this class
String	listingClass
String	listingPath
boolean	open

Element Detail

value

public abstract String value

Short description of the class

listingPath

public abstract String listingPath

Default:

""

listingClass

public abstract String listingClass

Default:

""

description

public abstract String description

General description of this class

Default:

""

open

public abstract boolean open

Default:

false

basePath

public abstract String basePath

The base path that is prepended to all @Path elements. This may be an override for certain scenarios only

Default:

""