org.eclipse.microprofile.openapi.reader.MyOASModelReaderImpl Maven / Gradle / Ivy
/**
* 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.
*/
package org.eclipse.microprofile.openapi.reader;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import org.eclipse.microprofile.openapi.OASFactory;
import org.eclipse.microprofile.openapi.OASModelReader;
import org.eclipse.microprofile.openapi.models.Components;
import org.eclipse.microprofile.openapi.models.ExternalDocumentation;
import org.eclipse.microprofile.openapi.models.OpenAPI;
import org.eclipse.microprofile.openapi.models.Operation;
import org.eclipse.microprofile.openapi.models.PathItem;
import org.eclipse.microprofile.openapi.models.Paths;
import org.eclipse.microprofile.openapi.models.examples.Example;
import org.eclipse.microprofile.openapi.models.headers.Header;
import org.eclipse.microprofile.openapi.models.info.Contact;
import org.eclipse.microprofile.openapi.models.info.Info;
import org.eclipse.microprofile.openapi.models.info.License;
import org.eclipse.microprofile.openapi.models.links.Link;
import org.eclipse.microprofile.openapi.models.media.Content;
import org.eclipse.microprofile.openapi.models.media.MediaType;
import org.eclipse.microprofile.openapi.models.media.Schema;
import org.eclipse.microprofile.openapi.models.parameters.Parameter;
import org.eclipse.microprofile.openapi.models.parameters.RequestBody;
import org.eclipse.microprofile.openapi.models.responses.APIResponse;
import org.eclipse.microprofile.openapi.models.responses.APIResponses;
import org.eclipse.microprofile.openapi.models.security.SecurityRequirement;
import org.eclipse.microprofile.openapi.models.security.SecurityScheme;
import org.eclipse.microprofile.openapi.models.servers.Server;
import org.eclipse.microprofile.openapi.models.servers.ServerVariable;
import org.eclipse.microprofile.openapi.models.servers.ServerVariables;
import org.eclipse.microprofile.openapi.models.tags.Tag;
public class MyOASModelReaderImpl implements OASModelReader {
@Override
public OpenAPI buildModel() {
return OASFactory.createObject(OpenAPI.class)
.info(OASFactory.createObject(Info.class)
.title("AirlinesRatingApp API")
.version("1.0")
.termsOfService("http://airlinesratingapp.com/terms")
.contact(OASFactory.createObject(Contact.class)
.name("AirlinesRatingApp API Support")
.url("http://exampleurl.com/contact")
.email("[email protected]"))
.license(OASFactory.createObject(License.class)
.name("Apache 2.0")
.url("http://www.apache.org/licenses/LICENSE-2.0.html")))
.security(new ArrayList())
.addSecurityRequirement(OASFactory.createObject(SecurityRequirement.class)
.addScheme("airlinesRatingApp_auth"))
.servers(new ArrayList())
.addServer(OASFactory.createObject(Server.class)
.url("https://{username}.gigantic-server.com:{port}/{basePath}")
.description("The production API server")
.variables(OASFactory.createObject(ServerVariables.class)
.addServerVariable("username", OASFactory.createObject(ServerVariable.class)
.defaultValue("user1")
.description("Reviews of the app by users")
.enumeration(new ArrayList())
.addEnumeration("user1")
.addEnumeration("user2"))
.addServerVariable("port", OASFactory.createObject(ServerVariable.class)
.defaultValue("8443")
.description("Booking data"))
.addServerVariable("user", OASFactory.createObject(ServerVariable.class)
.defaultValue("user")
.description("User data"))
.addServerVariable("basePath", OASFactory.createObject(ServerVariable.class)
.defaultValue("v2"))))
.addServer(OASFactory.createObject(Server.class)
.url("https://test-server.com:80/basePath")
.description("The test API server"))
.components(OASFactory.createObject(Components.class)
.schemas(new HashMap())
.addSchema("Bookings", OASFactory.createObject(Schema.class)
.type(Schema.SchemaType.INTEGER)
.title("Bookings")
.ref("#/components.schemas.Booking"))
.addSchema("Airlines", OASFactory.createObject(Schema.class)
.type(Schema.SchemaType.INTEGER)
.title("Airlines"))
.addSchema("AirlinesRef", OASFactory.createObject(Schema.class)
.ref("#/components/schemas/Airlines"))
.addSchema("id", OASFactory.createObject(Schema.class)
.type(Schema.SchemaType.INTEGER)
.format("int32"))
.responses(new HashMap())
.addResponse("FoundAirlines", OASFactory.createObject(APIResponse.class)
.description("successfully found airlines")
.content(OASFactory.createObject(Content.class)
.addMediaType("application/json", OASFactory.createObject(MediaType.class)
.schema(OASFactory.createObject(Schema.class)
.type(Schema.SchemaType.ARRAY)))))
.addResponse("FoundBookings", OASFactory.createObject(APIResponse.class)
.description("Bookings retrieved")
.content(OASFactory.createObject(Content.class)
.addMediaType("application/json", OASFactory.createObject(MediaType.class)
.schema(OASFactory.createObject(Schema.class)
.type(Schema.SchemaType.ARRAY)
.ref("#/components.schemas.Booking")))))
.parameters(new HashMap())
.addParameter("departureDate", OASFactory.createObject(Parameter.class)
.required(true)
.description("Customer departure date")
.schema(OASFactory.createObject(Schema.class)))
.addParameter("username", OASFactory.createObject(Parameter.class)
.required(true)
.description("The name that needs to be deleted")
.schema(OASFactory.createObject(Schema.class)))
.examples(new HashMap())
.addExample("review", OASFactory.createObject(Example.class)
.summary("External review example")
.description("This example exemplifies the content on our site.")
.externalValue("http://foo.bar/examples/review-example.json"))
.addExample("user", OASFactory.createObject(Example.class)
.summary("External user example")
.externalValue("http://foo.bar/examples/user-example.json"))
.requestBodies(new HashMap())
.addRequestBody("review", OASFactory.createObject(RequestBody.class)
.required(true)
.description("example review to add")
.content(OASFactory.createObject(Content.class)
.addMediaType("application/json", OASFactory.createObject(MediaType.class)
.schema(OASFactory.createObject(Schema.class)
.ref("#/components.schemas.Review")))))
.headers(new HashMap())
.addHeader("Max-Rate", OASFactory.createObject(Header.class)
.description("Maximum rate")
.schema(OASFactory.createObject(Schema.class)
.type(Schema.SchemaType.INTEGER))
.required(true)
.allowEmptyValue(true)
.deprecated(true))
.addHeader("Request-Limit", OASFactory.createObject(Header.class)
.description("The number of allowed requests in the current period")
.schema(OASFactory.createObject(Schema.class)
.type(Schema.SchemaType.INTEGER)))
.securitySchemes(new HashMap())
.addSecurityScheme("httpTestScheme", OASFactory.createObject(SecurityScheme.class)
.description("user security scheme")
.type(SecurityScheme.Type.HTTP)
.scheme("testScheme"))
.links(new HashMap())
.addLink("UserName", OASFactory.createObject(Link.class)
.description("The username corresponding to provided user id")
.operationId("getUserByName")
.parameters(new HashMap())
.addParameter("userId", "$request.link-path.userId")))
.tags(new ArrayList())
.addTag(OASFactory.createObject(Tag.class)
.name("Get Airlines")
.description("method to get all airlines"))
.addTag(OASFactory.createObject(Tag.class)
.name("Retrieve Airlines")
.description("method to retrieve all airlines"))
.addTag(OASFactory.createObject(Tag.class)
.name("user")
.description("Operations about user"))
.addTag(OASFactory.createObject(Tag.class)
.name("create")
.description("Operations about create"))
.addTag(OASFactory.createObject(Tag.class)
.name("Bookings")
.description("All the bookings methods"))
.addTag(OASFactory.createObject(Tag.class)
.name("Airlines")
.description("All the airlines methods"))
.addTag(OASFactory.createObject(Tag.class)
.name("Availability")
.description("All the availability methods"))
.addTag(OASFactory.createObject(Tag.class)
.name("Get Flights")
.description("method to retrieve all flights available")
.externalDocs(OASFactory.createObject(ExternalDocumentation.class)
.description("A list of all the flights offered by the app")
.url("http://airlinesratingapp.com/ourflights")))
.externalDocs(OASFactory.createObject(ExternalDocumentation.class)
.description("instructions for how to deploy this app")
.url("https://github.com/microservices-api/oas3-airlines/blob/master/README.md"))
.paths(OASFactory.createObject(Paths.class)
.addPathItem("/modelReader/airlines", OASFactory.createObject(PathItem.class)
.GET(OASFactory.createObject(Operation.class)
.summary("Retrieve all available airlines")
.operationId("getAirlines")
.responses(OASFactory.createObject(APIResponses.class)
.addAPIResponse("404", OASFactory.createObject(APIResponse.class)
.description("No airlines found")
.content(OASFactory.createObject(Content.class)
.addMediaType("n/a", OASFactory.createObject(MediaType.class)))))))
.addPathItem("/availabilityModel", OASFactory.createObject(PathItem.class)
.GET(OASFactory.createObject(Operation.class)
.tags(new ArrayList())
.addTag("Availability")
.summary("TEST SUMMARY")
.operationId("getTestFlights")
.responses(OASFactory.createObject(APIResponses.class)
.addAPIResponse("200", OASFactory.createObject(APIResponse.class)
.description("successful operation")
.content(OASFactory.createObject(Content.class)
.addMediaType("application/json", OASFactory.createObject(MediaType.class)
.schema(OASFactory.createObject(Schema.class)
.type(Schema.SchemaType.ARRAY)
.ref("#/components.schemas.Flight")))))
.addAPIResponse("404", OASFactory.createObject(APIResponse.class)
.description("No available flights found")
.content(OASFactory.createObject(Content.class)
.addMediaType("n/a", OASFactory.createObject(MediaType.class)))))
.parameters(new ArrayList())
.addParameter(OASFactory.createObject(Parameter.class)
.ref("#/components/parameters/departureDate"))
.addParameter(OASFactory.createObject(Parameter.class)
.name("airportFrom")
.required(true)
.in(Parameter.In.QUERY)
.allowEmptyValue(true)
.description("Airport the customer departs from")
.schema(OASFactory.createObject(Schema.class)
.type(Schema.SchemaType.STRING)))
.addParameter(OASFactory.createObject(Parameter.class)
.name("returningDate")
.required(true)
.in(Parameter.In.QUERY)
.allowReserved(true)
.description("Customer return date")
.schema(OASFactory.createObject(Schema.class)
.type(Schema.SchemaType.STRING)))
.addParameter(OASFactory.createObject(Parameter.class)
.name("airportTo")
.required(true)
.in(Parameter.In.QUERY)
.description("Airport the customer returns to")
.schema(OASFactory.createObject(Schema.class)
.type(Schema.SchemaType.STRING)))
.addParameter(OASFactory.createObject(Parameter.class)
.name("numberOfAdults")
.required(true)
.in(Parameter.In.QUERY)
.description("Number of adults on the flight")
.schema(OASFactory.createObject(Schema.class)
.minimum(new BigDecimal(0))
.type(Schema.SchemaType.STRING)))
.addParameter(OASFactory.createObject(Parameter.class)
.name("numberOfChildren")
.required(true)
.deprecated(true)
.in(Parameter.In.QUERY)
.description("Number of children on the flight")
.schema(OASFactory.createObject(Schema.class)
.minimum(new BigDecimal(0))
.type(Schema.SchemaType.STRING)))))
.addPathItem("/modelReader/bookings", OASFactory.createObject(PathItem.class)
.GET(OASFactory.createObject(Operation.class)
.tags(new ArrayList())
.addTag("bookings")
.summary("Retrieve all bookings for current user")
.operationId("getAllBookings")
.responses(OASFactory.createObject(APIResponses.class)
.addAPIResponse("200", OASFactory.createObject(APIResponse.class)
.description("Bookings retrieved")
.content(OASFactory.createObject(Content.class)
.addMediaType("applictaion/json", OASFactory.createObject(MediaType.class)
.schema(OASFactory.createObject(Schema.class)
.type(Schema.SchemaType.ARRAY)
.ref("#/components.schemas.Booking")))))
.addAPIResponse("404", OASFactory.createObject(APIResponse.class)
.description("No bookings found for the user"))))
.POST(OASFactory.createObject(Operation.class)
.security(new ArrayList())
.addSecurityRequirement(OASFactory.createObject(SecurityRequirement.class)
.addScheme("bookingSecurityScheme", new ArrayList(Arrays.asList("write:bookings", "read:bookings"))))
.summary("Create a booking")
.description("Create a new booking record with the booking information provided.")
.operationId("createBooking")
.responses(OASFactory.createObject(APIResponses.class)
.addAPIResponse("201", OASFactory.createObject(APIResponse.class)
.description("Bookings created")
.content(OASFactory.createObject(Content.class)
.addMediaType("text/plain", OASFactory.createObject(MediaType.class)
.schema(OASFactory.createObject(Schema.class)
.title("id")
.description("id of the new booking")
.type(Schema.SchemaType.STRING)))))))));
}
}