Package io.swagger.annotations

Annotation Type Contact

  • @Target(ANNOTATION_TYPE)
@Retention(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 Description
      String name
      The name of the contact.

    • Optional Element Summary

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

    • Element Detail

      • name

        String name
        The name of the contact.
        Returns:
        the name of the contact

      • url

        String url
        Optional URL associated with this contact.
        Returns:
        an optional URL associated with this contact
        Default:
        ""

      • email

        String email
        Optional email for this contact.
        Returns:
        an optional email for this contact
        Default:
        ""