Package org.apache.juneau.http

Annotation Interface License

@Documented
@Retention(RUNTIME)
public @interface License

Swagger license annotation.

License information for the exposed API.

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

Example:

@Swagger( license=@License( name="Apache 2.0", url="http://www.apache.org/licenses/LICENSE-2.0.html" ) )

See Also:

• juneau-bean-swagger-v2
• Swagger License Object

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	description	Optional description for the exposed API.
String	name	name field of the Swagger License Object.
String	url	url field of the Swagger License Object.

Element Details

description

String[] description

Optional description for the exposed API.

Returns:

The annotation value.

Since:

9.2.0

Default:

{}

name

String name

name field of the Swagger License Object.

Notes:

• The format is a plain-text string.
• Supports REST Server 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 License Object.

Notes:

• The format is a plain-text string.
• Supports REST Server SVL Variables (e.g. "$L{my.localized.variable}") for the swagger generator.

Returns:

The annotation value.

Default:

""