Top Description Annotations
module org.eclipse.microprofile.openapi

Package org.eclipse.microprofile.openapi.annotations.servers

Annotations
@Version:1.1
@ProviderType

Annotations to represent servers used for a single API operation or for all operations in an OpenAPI document, as well as a way to represent variables for server URL template substitution.

Example usage:

@POST
@Servers(value={
     @Server(url = "localhost:9080/{proxyPath}/reviews/id",
             description = "view of all the reviews",
             variables = { @ServerVariable(name = "proxyPath", description = "Base path of the proxy", defaultValue = "proxy") }),
     @Server(url = "http://random.url/reviews", description = "random text")
})

Annotation Summary

Modifier and TypeAnnotation and Description
public @interface
Server

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

public @interface
Servers

The Servers annotation is a container for @Server annotations.

public @interface
ServerVariable

An object representing a Server Variable for server URL template substitution.