com.wordnik.swagger.annotations
Annotation Type ApiClass

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

A bean class used in the REST-api. Suppose you have an interface @PUT @ApiOperation(...) void foo(FooBean fooBean), there is no direct way to see what fields FooBean would have. This annotation is meant to give a description of FooBean and then have the fields of it be annotated with @ApiProperty.

Author:

Heiko W. Rupp

Optional Element Summary

String	description Provide a longer description of the class
String	value Provide a synopsis of this class

value

public abstract String value

Provide a synopsis of this class

Default:

""

description

public abstract String description

Provide a longer description of the class

Default:

""