Package org.apache.juneau.http.annotation

Annotation Type Contact

@Documented @Retention(RUNTIME) public @interface Contact
Swagger contact annotation.

The contact information for the exposed API.

Used to populate the auto-generated Swagger documentation and UI for server-side @Rest-annotated classes.

Example:

@Swagger( contact=@Contact( name="Juneau Development Team", email="dev@juneau.apache.org", url="http://juneau.apache.org" ) )

See Also:

  • Element Details

    • email

      String email
      email field of the Swagger Contact Object.

      The email address of the contact person/organization. MUST be in the format of an email address.

      Notes:
      • The format is an email string.
      • Supports SVL Variables (e.g. "$L{my.localized.variable}") for the swagger generator.
      Returns:
      The annotation value.
      Default:
      ""

    • name

      String name
      name field of the Swagger Contact Object.

      The identifying name of the contact person/organization.

      Notes:
      • The format is a plain-text string.
      • Supports SVL Variables (e.g. "$L{my.localized.variable}") for the swagger generator.
      Returns:
      The annotation value.
      Default:
      ""

    • url

      String url
      url field of the Swagger Contact Object.

      The URL pointing to the contact information. MUST be in the format of a URL.

      Notes:
      • The format is a URL string.
      • Supports SVL Variables (e.g. "$L{my.localized.variable}").
      Returns:
      The annotation value.
      Default:
      ""