public @interface ResourceSwagger
@RestResource(swagger)
.
Modifier and Type | Optional Element and Description |
---|---|
Contact |
contact
Defines the swagger field
|
String[] |
description
Defines the swagger field
|
ExternalDocs |
externalDocs
Defines the swagger field
|
License |
license
Defines the swagger field
|
Tag[] |
tags
Defines the swagger field
|
String[] |
termsOfService
Defines the swagger field
|
String[] |
title
Defines the swagger field
|
String[] |
value
Free-form value for the swagger of a resource.
|
String |
version
Defines the swagger field
|
public abstract String[] title
title()
on this class, then any parent classes.
RestResource.title()
on this class, then any parent classes.
public abstract String[] description
description()
on this class, then any parent classes.
RestResource.description()
on this class, then any parent classes.
public abstract Contact contact
A Simple JSON string with the following fields:
{ name: string, url: string, email: string }
The default value pulls the description from the
public abstract 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
public abstract License license
It is used to populate the Swagger license field and to display on HTML pages.
A Simple JSON string with the following fields:
{ name: string, url: string }
The default value pulls the description from the
public abstract Tag[] tags
It is used to populate the Swagger tags field and to display on HTML pages.
A Simple JSON string with the following fields:
[ { name: string, description: string, externalDocs: { description: string, url: string } } ]
The default value pulls the description from the
public abstract String[] termsOfService
It is used to populate the Swagger terms-of-service field.
The default value pulls the description from the
public abstract String version
It is used to populate the Swagger version field and to display on HTML pages.
The default value pulls the description from the
public abstract String[] value
This is a Simple 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:
Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.