@Documented @Retention(value=RUNTIME) public @interface Contact
The contact information for the exposed API.
Used to populate the auto-generated Swagger documentation and UI for server-side
Modifier and Type | Optional Element and Description |
---|---|
String |
email
|
String |
name
|
String |
url
|
String[] |
value
Free-form value for the Swagger Contact Object.
|
public abstract String name
The identifying name of the contact person/organization.
public abstract String url
The URL pointing to the contact information. MUST be in the format of a URL.
public abstract String email
The email address of the contact person/organization. MUST be in the format of an email address.
public abstract String[] value
This is a JSON object that makes up the swagger information for this field.
The following are completely equivalent ways of defining the swagger description of the contact information:
The reasons why you may want to use this field include:
Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.