Package org.eclipse.microprofile.openapi.models.servers
@Version("2.0")
@ProviderType
package org.eclipse.microprofile.openapi.models.servers
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"))); }
-
ClassDescriptionAn object representing a server.An object representing a Server Variable for server URL template substitution.