public @interface ResourceSwagger
Modifier and Type | Optional Element and Description |
---|---|
Contact |
contact
Defines the swagger field
/info/contact . |
String[] |
description
Defines the swagger field
/info/description . |
ExternalDocs |
externalDocs
Defines the swagger field
/externalDocs . |
License |
license
Defines the swagger field
/info/license . |
Tag[] |
tags
Defines the swagger field
/tags . |
String[] |
termsOfService
Defines the swagger field
/info/termsOfService . |
String[] |
title
Defines the swagger field
/info/title . |
String[] |
value
Free-form value for the swagger of a resource.
|
String |
version
Defines the swagger field
/info/version . |
public abstract String[] title
/info/title
.
{resource-class}.title
property in resource bundle.
title()
on this class, then any parent classes.
RestResource.title()
on this class, then any parent classes.
public abstract String[] description
/info/description
.
{resource-class}.description
property in resource bundle.
description()
on this class, then any parent classes.
RestResource.description()
on this class, then any parent classes.
public abstract Contact contact
/info/contact
.
A Overview > juneau-marshall > JSON Details > Simplified JSON string with the following fields:
{ name: string, url: string, email: string }
The default value pulls the description from the contact
entry in the servlet resource bundle.
(e.g.
public abstract ExternalDocs externalDocs
/externalDocs
.
It is used to populate the Swagger external documentation field and to display on HTML pages. *
The default value pulls the description from the externalDocs
entry in the servlet resource bundle.
(e.g.
public abstract License license
/info/license
.
It is used to populate the Swagger license field and to display on HTML pages.
A Overview > juneau-marshall > JSON Details > Simplified JSON string with the following fields:
{ name: string, url: string }
The default value pulls the description from the license
entry in the servlet resource bundle.
(e.g.
public abstract Tag[] tags
/tags
.
Optional tagging information for the exposed API.
It is used to populate the Swagger tags field and to display on HTML pages.
A Overview > juneau-marshall > JSON Details > Simplified JSON string with the following fields:
[ { name: string, description: string, externalDocs: { description: string, url: string } } ]
The default value pulls the description from the tags
entry in the servlet resource bundle.
(e.g.
public abstract String[] termsOfService
/info/termsOfService
.
Optional servlet terms-of-service for this API.
It is used to populate the Swagger terms-of-service field.
The default value pulls the description from the termsOfService
entry in the servlet resource bundle.
(e.g.
public abstract String version
/info/version
.
Provides the version of the application API (not to be confused with the specification version).
It is used to populate the Swagger version field and to display on HTML pages.
The default value pulls the description from the version
entry in the servlet resource bundle.
(e.g.
public abstract String[] value
This is a Overview > juneau-marshall > JSON Details > Simplified JSON object that makes up the swagger information for this resource.
The following are completely equivalent ways of defining the swagger description of a resource:
The reasons why you may want to use this field include:
{ }
characters are optional.
Copyright © 2018 Apache. All rights reserved.