io.swagger.annotations

Annotation Type Contact

@Target(value=ANNOTATION_TYPE)
@Retention(value=RUNTIME)
public @interface Contact

Contact metadata available within the info section of a Swagger definition - see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#contactObject

Since:

1.5.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The name of the contact.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	email Optional email for this contact.
String	url Optional URL associated with this contact.

Element Detail

name

public abstract String name

The name of the contact.

Returns:

the name of the contact

url

public abstract String url

Optional URL associated with this contact.

Returns:

an optional URL associated with this contact

Default:

""

email

public abstract String email

Optional email for this contact.

Returns:

an optional email for this contact

Default:

""