Package io.swagger.annotations

Annotation Type Info

  • @Target(ANNOTATION_TYPE)
@Retention(RUNTIME)
public @interface Info
    High-level metadata for a Swagger definition - see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#infoObject
    Since:
    1.5.0

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String title
      The title of the API.
      String version
      The version of your API.

    • Element Detail

      • title

        String title
        The title of the API.
        Returns:
        the title of the API

      • version

        String version
        The version of your API.
        Returns:
        the version of your API

      • description

        String description
        An optional description of the API.
        Returns:
        an optional description of the API
        Default:
        ""

      • termsOfService

        String termsOfService
        An optional terms of service for this API.
        Returns:
        an optional terms of service for this API
        Default:
        ""

      • contact

        Contact contact
        Optional contact information for this API.
        Returns:
        optional contact information for this API
        Default:
        @io.swagger.annotations.Contact(name="")

      • license

        License license
        Optional license information for this API.
        Returns:
        optional license information for this API
        Default:
        @io.swagger.annotations.License(name="")

      • extensions

        Extension[] extensions
        Optional list of extensions for this API.
        Returns:
        optional list of extensions for this API
        See Also:
        Extension
        Default:
        {@io.swagger.annotations.Extension(properties={@io.swagger.annotations.ExtensionProperty(name="", value="")})}