@Target(value=TYPE) @Retention(value=RUNTIME) public @interface ApiModel
@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
.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
|
public abstract String value
public abstract String description
public abstract Class<?> parent
public abstract String discriminator
public abstract Class<?>[] subTypes
Copyright © 2014. All Rights Reserved.