org.eclipse.microprofile.openapi.models.servers.package-info Maven / Gradle / Ivy
Show all versions of microprofile-openapi-api Show documentation
/*
* Copyright (c) 2017 Contributors to the Eclipse Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a
* copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations
* under the License.
*/
/**
* 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:
*
*
* {@literal}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")));
* }
*
*/
@org.osgi.annotation.versioning.Version("2.0")
@org.osgi.annotation.versioning.ProviderType
package org.eclipse.microprofile.openapi.models.servers;