Top Description Interfaces
module org.eclipse.microprofile.openapi

Package org.eclipse.microprofile.openapi.models.servers

Annotations
@Version:2.0
@ProviderType

Model interfaces 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.

The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification.

Example usage:

Override
 public OpenAPI buildModel() {
     return OASFactory.createOpenAPI()
             .addServer(OASFactory.createServer()
                     .url("https://{username}.example-server.com:8080/api")
                     .description("The production API server")
                     .addVariable("username", OASFactory.createServerVariable()
                             .defaultValue("user1")
                             .description("Reviews of the app by users")
                             .addEnumeration("user1")
                             .addEnumeration("user2")));
 }

Interface Summary

Modifier and TypeInterface and Description
public interface
Server

An object representing a server.

public interface
ServerVariable

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