MicroProfile 7.0 · org.eclipse.microprofile.openapi.annotations.servers.Server

This annotation represents a Server used in an operation or used by all operations in an OpenAPI document.

When a Server annotation appears on a method the server is added to the corresponding OpenAPI operation servers field.

When a Server annotation appears on a type then the server is added to all the operations defined in that type except for those operations which already have one or more servers defined. The server is also added to the servers defined in the root level of the OpenAPI document.

This annotation is Repeatable.

Note

If both Server and Servers annotation are specified on the same type, the server definitions will be combined.

Method Summary

Modifier and Type	Method and Description
public String	Returns: description of the host designated by URL description() An optional string describing the host designated by the URL.
public Extension[]	Returns: array of extensions extensions() List of extensions to be added to the `Server` model corresponding to the containing annotation.
public String	Returns: URL to the target host url() A URL to the target host.
public ServerVariable[]	Returns: array of variables variables() An array of variables used for substitution in the server's URL template.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

description	back to summary
public String description() An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation. Returns:String description of the host designated by URL

description

back to summary

public String description()

An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.

Returns:String: description of the host designated by URL

extensions back to summary

extensions	back to summary
public Extension[] extensions() List of extensions to be added to the `Server` model corresponding to the containing annotation. Returns:Extension[] array of extensions Since 3.1

public Extension[] extensions()

List of extensions to be added to the Server model corresponding to the containing annotation.

Returns:Extension[]: array of extensions
Since: 3.1

url	back to summary
public String url() A URL to the target host. This URL supports Server Variables and may be relative, to indicate that the host location is relative to the location where the OpenAPI definition is being served. Variable substitutions will be made when a variable is named in {brackets}. This is a REQUIRED property. Returns:String URL to the target host

url

back to summary

public String url()

A URL to the target host. This URL supports Server Variables and may be relative, to indicate that the host location is relative to the location where the OpenAPI definition is being served. Variable substitutions will be made when a variable is named in {brackets}. This is a REQUIRED property.

Returns:String: URL to the target host

variables	back to summary
public ServerVariable[] variables() An array of variables used for substitution in the server's URL template. Returns:ServerVariable[] array of variables

variables

back to summary

public ServerVariable[] variables()

An array of variables used for substitution in the server's URL template.

Returns:ServerVariable[]: array of variables

public @Interface Server

Method Summary

Method Detail