com.wordnik.swagger.annotations

Annotation Type ApiModel

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

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 @ApiModelProperty.

Author:

Heiko W. Rupp

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description Provide a longer description of the class
String	discriminator for models with a base class, a discriminator can be provided for polymorphic use cases
Class<?>	parent Provide a superclass for the model to allow describing inheritence
Class<?>[]	subTypes
String	value Provide a synopsis of this class

Element Detail

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:

""

parent

public abstract Class<?> parent

Provide a superclass for the model to allow describing inheritence

Default:

java.lang.Void.class

discriminator

public abstract String discriminator

for models with a base class, a discriminator can be provided for polymorphic use cases

Default:

""

subTypes

public abstract Class<?>[] subTypes

Default:

{}