Package org.apache.juneau.bean.swagger

Class Info

java.lang.Object
org.apache.juneau.bean.swagger.SwaggerElement
org.apache.juneau.bean.swagger.Info
public class Info extends SwaggerElement
Provides metadata about the API.

The Info Object provides metadata about the API for Swagger 2.0. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience. This includes the title, version, description, terms of service, contact information, and license.

Swagger Specification:

The Info Object is composed of the following fields:

  • title (string, REQUIRED) - The title of the API
  • version (string, REQUIRED) - The version of the OpenAPI document (not the API itself)
  • description (string) - A short description of the API
  • termsOfService (string) - A URL to the Terms of Service for the API
  • contact (Contact) - Contact information for the exposed API
  • license (License) - License information for the exposed API
Example:

// Construct using SwaggerBuilder. Info info = info("Swagger Sample App", "1.0.1") .description("This is a sample server Petstore server.") .termsOfService("http://swagger.io/terms/") .contact( contact("API Support", "http://www.swagger.io/support", "support@swagger.io") ) .license( license("Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0.html") ); // Serialize using JsonSerializer. String json = Json.from(info); // Or just use toString() which does the same as above. json = info.toString();

// Output { "title": "Swagger Sample App", "description": "This is a sample server Petstore server.", "termsOfService": "http://swagger.io/terms/", "contact": { "name": "API Support", "url": "http://www.swagger.io/support", "email": "support@swagger.io" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.1" }

See Also:

  • Constructor Details

    • Info

      public Info()
      Default constructor.

    • Info

      public Info(Info copyFrom)
      Copy constructor.
      Parameters:
      copyFrom - The object to copy.

  • Method Details

    • copy

      public Info copy()
      Make a deep copy of this object.
      Returns:
      A deep copy of this object.

    • getContact

      public Contact getContact()
      Bean property getter: contact.

      The contact information for the exposed API.

      Returns:
      The property value, or null if it is not set.

    • setContact

      public Info setContact(Contact value)
      Bean property setter: contact.

      The contact information for the exposed API.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object.

    • getDescription

      public String getDescription()
      Bean property getter: description.

      A short description of the application.

      Returns:
      The property value, or null if it is not set.

    • setDescription

      public Info setDescription(String value)
      Bean property setter: description.

      A short description of the application.

      Parameters:
      value - The new value for this property.
      GFM syntax can be used for rich text representation.
      Can be null to unset the property.
      Returns:
      This object.

    • getLicense

      public License getLicense()
      Bean property getter: license.

      The license information for the exposed API.

      Returns:
      The property value, or null if it is not set.

    • setLicense

      public Info setLicense(License value)
      Bean property setter: license.

      The license information for the exposed API.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object.

    • getSiteName

      public String getSiteName()
      Bean property getter: siteName.

      The site name of the application.

      Returns:
      The property value, or null if it is not set.

    • setSiteName

      public Info setSiteName(String value)
      Bean property setter: siteName.

      The site name of the application.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object.

    • getTermsOfService

      public String getTermsOfService()
      Bean property getter: termsOfService.

      The Terms of Service for the API.

      Returns:
      The property value, or null if it is not set.

    • setTermsOfService

      public Info setTermsOfService(String value)
      Bean property setter: termsOfService.

      The Terms of Service for the API.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object.

    • getTitle

      public String getTitle()
      Bean property getter: title.

      The title of the application.

      Returns:
      The property value, or null if it is not set.

    • setTitle

      public Info setTitle(String value)
      Bean property setter: title.

      The title of the application.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object.

    • getVersion

      public String getVersion()
      Bean property getter: version.

      The version of the application API (not to be confused with the specification version).

      Returns:
      The property value, or null if it is not set.

    • setVersion

      public Info setVersion(String value)
      Bean property setter: version.

      The version of the application API (not to be confused with the specification version).

      Parameters:
      value - The new value for this property.
      Property value is required.
      Can be null to unset the property.
      Returns:
      This object.

    • get

      public <T> T get(String property, Class<T> type)
      Description copied from class: SwaggerElement
      Generic property getter.

      Can be used to retrieve non-standard Swagger fields such as "$ref".

      Overrides:
      get in class SwaggerElement
      Type Parameters:
      T - The datatype to cast the value to.
      Parameters:
      property - The property name to retrieve.
      type - The datatype to cast the value to.
      Returns:
      The property value, or null if the property does not exist or is not set.

    • set

      public Info set(String property, Object value)
      Description copied from class: SwaggerElement
      Generic property setter.

      Can be used to set non-standard Swagger fields such as "$ref".

      Overrides:
      set in class SwaggerElement
      Parameters:
      property - The property name to set. Must not be null.
      value - The new value for the property.
      Returns:
      This object.

    • keySet

      public Set<String> keySet()
      Description copied from class: SwaggerElement
      Returns all the keys on this element.
      Overrides:
      keySet in class SwaggerElement
      Returns:
      All the keys on this element.
      Never null.

    • strict

      public Info strict()
      Sets strict mode on this bean.
      Overrides:
      strict in class SwaggerElement
      Returns:
      This object.

    • strict

      public Info strict(Object value)
      Sets strict mode on this bean.
      Overrides:
      strict in class SwaggerElement
      Parameters:
      value - The new value for this property.
      Non-boolean values will be converted to boolean using Boolean.valueOf(value.toString()).
      Can be null (interpreted as false).
      Returns:
      This object.