Package org.apache.juneau.annotation

Annotation Interface ExternalDocs

@Documented @Retention(RUNTIME) public @interface ExternalDocs
Swagger external documentation annotation.

Allows referencing an external resource for extended documentation.

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

Example:

@Swagger( externalDocs=@ExternalDocs( description="Apache Juneau", url="http://juneau.apache.org" ) )

See Also:

  • Element Details

    • description

      String[] description
      description field of the Swagger ExternalDocumentation Object.

      A short description of the target documentation.

      Notes:
      • The format is a plain-text string.
        Multiple lines are concatenated with newlines.
      • 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 ExternalDocumentation Object.

      The URL for the target documentation. Value MUST be in the format of a URL.

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