Package org.apache.juneau.dto.swagger

Class ExternalDocumentation

java.lang.Object
org.apache.juneau.dto.swagger.SwaggerElement
org.apache.juneau.dto.swagger.ExternalDocumentation
@Bean(properties="description,url,*") public class ExternalDocumentation extends SwaggerElement
Allows referencing an external resource for extended documentation.
Example:

// Construct using SwaggerBuilder. ExternalDocumentation extDoc = externalDocumentation("https://swagger.io", "Find more info here"); // Serialize using JsonSerializer. String json = JsonSerializer.DEFAULT.toString(extDoc); // Or just use toString() which does the same as above. json = extDoc.toString();

// Output { "description": "Find more info here", "url": "https://swagger.io" }

See Also:

  • Constructor Details

  • Method Details

    • copy

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

    • getDescription

      public String getDescription()
      Bean property getter: description.

      A short description of the target documentation.

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

    • setDescription

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

      A short description of the target documentation.

      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.

    • getUrl

      public URI getUrl()
      Bean property getter: url.

      The URL for the target documentation.

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

    • setUrl

      public ExternalDocumentation setUrl(URI value)
      Bean property setter: url.

      The URL for the target documentation.

      Parameters:
      value - The new value for this property.
      Property value is required.
      URIs defined by UriResolver can be used for values.
      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 ExternalDocumentation 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.
      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.