com.jetdrone.vertx.yoke.annotations

Annotation Type SwaggerDoc

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface SwaggerDoc

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	summary

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	notes
Parameter[]	parameters
String	refId
ResponseMessage[]	responseMessages
DataType	type

Element Detail

summary

public abstract String summary

notes

public abstract String[] notes

Default:

{}

type

public abstract DataType type

Default:

com.jetdrone.vertx.yoke.annotations.DataType.VOID

refId

public abstract String refId

Default:

""

parameters

public abstract Parameter[] parameters

Default:

{}

responseMessages

public abstract ResponseMessage[] responseMessages

Default:

{}