/
JAXRSApp.java
230 lines (224 loc) · 17.4 KB
/
JAXRSApp.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
/**
* Copyright (c) 2017 Contributors to the Eclipse Foundation
* <p>
* 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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.apps.airlines;
import java.util.HashSet;
import java.util.Random;
import java.util.Set;
import org.eclipse.microprofile.openapi.annotations.Components;
import org.eclipse.microprofile.openapi.annotations.ExternalDocumentation;
import org.eclipse.microprofile.openapi.annotations.OpenAPIDefinition;
import org.eclipse.microprofile.openapi.annotations.callbacks.Callback;
import org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation;
import org.eclipse.microprofile.openapi.annotations.enums.ParameterIn;
import org.eclipse.microprofile.openapi.annotations.enums.SchemaType;
import org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeIn;
import org.eclipse.microprofile.openapi.annotations.enums.SecuritySchemeType;
import org.eclipse.microprofile.openapi.annotations.extensions.Extension;
import org.eclipse.microprofile.openapi.annotations.headers.Header;
import org.eclipse.microprofile.openapi.annotations.info.Contact;
import org.eclipse.microprofile.openapi.annotations.info.Info;
import org.eclipse.microprofile.openapi.annotations.info.License;
import org.eclipse.microprofile.openapi.annotations.links.Link;
import org.eclipse.microprofile.openapi.annotations.links.LinkParameter;
import org.eclipse.microprofile.openapi.annotations.media.Content;
import org.eclipse.microprofile.openapi.annotations.media.ExampleObject;
import org.eclipse.microprofile.openapi.annotations.media.Schema;
import org.eclipse.microprofile.openapi.annotations.media.SchemaProperty;
import org.eclipse.microprofile.openapi.annotations.parameters.Parameter;
import org.eclipse.microprofile.openapi.annotations.parameters.RequestBody;
import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;
import org.eclipse.microprofile.openapi.annotations.security.SecurityRequirement;
import org.eclipse.microprofile.openapi.annotations.security.SecurityRequirementsSet;
import org.eclipse.microprofile.openapi.annotations.security.SecurityScheme;
import org.eclipse.microprofile.openapi.annotations.servers.Server;
import org.eclipse.microprofile.openapi.annotations.servers.ServerVariable;
import org.eclipse.microprofile.openapi.annotations.tags.Tag;
import org.eclipse.microprofile.openapi.apps.airlines.model.Airline;
import org.eclipse.microprofile.openapi.apps.airlines.model.Booking;
import org.eclipse.microprofile.openapi.apps.airlines.model.Review;
import org.eclipse.microprofile.openapi.apps.airlines.model.User;
import org.eclipse.microprofile.openapi.apps.airlines.resources.AirlinesResource;
import org.eclipse.microprofile.openapi.apps.airlines.resources.AvailabilityResource;
import org.eclipse.microprofile.openapi.apps.airlines.resources.ReviewResource;
import org.eclipse.microprofile.openapi.apps.airlines.resources.UserResource;
import org.eclipse.microprofile.openapi.apps.airlines.resources.bookings.BookingResource;
import jakarta.ws.rs.ApplicationPath;
import jakarta.ws.rs.core.Application;
import jakarta.ws.rs.core.MediaType;
@ApplicationPath("/")
@OpenAPIDefinition(
tags = {@Tag(name = "user", description = "Operations about user"),
@Tag(name = "create", description = "Operations about create"),
@Tag(name = "Bookings", description = "All the bookings methods",
extensions = @Extension(name = "x-tag", value = "test-tag"))},
externalDocs = @ExternalDocumentation(description = "instructions for how to deploy this app",
url = "https://github.com/microservices-api/oas3-airlines/blob/master/README.md",
extensions = @Extension(name = "x-external-docs",
value = "test-external-docs")),
info = @Info(title = "AirlinesRatingApp API", version = "1.0",
termsOfService = "http://airlinesratingapp.com/terms",
contact = @Contact(name = "AirlinesRatingApp API Support",
url = "http://exampleurl.com/contact",
email = "techsupport@airlinesratingapp.com",
extensions = @Extension(name = "x-contact", value = "test-contact")),
license = @License(name = "Apache 2.0",
url = "http://www.apache.org/licenses/LICENSE-2.0.html",
extensions = @Extension(name = "x-license", value = "test-license")),
extensions = {@Extension(name = "x-info-1", value = "test-info-1"),
@Extension(name = "x-info", value = "test-info")
}),
security = @SecurityRequirement(name = "airlinesRatingApp_auth"),
securitySets = @SecurityRequirementsSet({
@SecurityRequirement(name = "testScheme1"), @SecurityRequirement(name = "testScheme2")
}),
servers = {
@Server(url = "https://{username}.gigantic-server.com:{port}/{basePath}",
description = "The production API server",
variables = {
@ServerVariable(name = "username",
description = "Reviews of the app by users",
defaultValue = "user1", enumeration = {
"user1", "user2"}),
@ServerVariable(name = "port", description = "Booking data",
defaultValue = "8443"),
@ServerVariable(name = "user", description = "User data",
defaultValue = "user",
extensions = @Extension(name = "x-server-variable",
value = "test-server-variable")),
@ServerVariable(name = "basePath", defaultValue = "v2")
},
extensions = @Extension(name = "x-server", value = "test-server")),
@Server(url = "https://test-server.com:80/basePath", description = "The test API server")
},
components = @Components(
schemas = {
@Schema(name = "Bookings", title = "Bookings",
type = SchemaType.ARRAY,
implementation = Booking.class),
@Schema(name = "Airlines", title = "Airlines",
type = SchemaType.ARRAY,
implementation = Airline.class,
extensions = @Extension(name = "x-schema",
value = "test-schema")),
@Schema(name = "id", type = SchemaType.INTEGER, format = "int32"),
@Schema(name = "AirlinesRef",
ref = "#/components/schemas/Airlines"),
@Schema(name = "User", implementation = User.class, properties = {
@SchemaProperty(name = "phone",
description = "Telephone number to contact the user",
example = "123-456-7891",
extensions = @Extension(name = "x-schema-property",
value = "test-schema-property"))
})},
responses = {
@APIResponse(name = "FoundAirlines", responseCode = "200",
description = "successfully found airlines",
content = @Content(mediaType = MediaType.APPLICATION_JSON,
schema = @Schema(type = SchemaType.ARRAY,
implementation = Airline.class))),
@APIResponse(name = "FoundBookings", responseCode = "200",
description = "Bookings retrieved",
content = @Content(schema = @Schema(type = SchemaType.ARRAY,
implementation = Booking.class)))
},
parameters = {
@Parameter(name = "departureDate", in = ParameterIn.QUERY,
required = true,
description = "Customer departure date",
schema = @Schema(implementation = String.class)),
@Parameter(name = "username", in = ParameterIn.QUERY,
description = "The name that needs to be deleted",
schema = @Schema(type = SchemaType.STRING),
required = true)
},
examples = {
@ExampleObject(name = "review", summary = "External review example",
description = "This example exemplifies the content on our site.",
externalValue = "http://foo.bar/examples/review-example.json",
extensions = @Extension(name = "x-example-object",
value = "test-example-object")),
@ExampleObject(name = "user", summary = "External user example",
externalValue = "http://foo.bar/examples/user-example.json")
},
requestBodies = {
@RequestBody(name = "review",
content = @Content(mediaType = MediaType.APPLICATION_JSON,
schema = @Schema(implementation = Review.class)),
required = true, description = "example review to add")
},
headers = {
@Header(name = "Max-Rate", description = "Maximum rate",
schema = @Schema(type = SchemaType.INTEGER),
required = true, allowEmptyValue = true,
deprecated = true,
extensions = @Extension(name = "x-header",
value = "test-header")),
@Header(name = "Request-Limit",
description = "The number of allowed requests in the current period",
schema = @Schema(type = SchemaType.INTEGER))
},
securitySchemes = {
@SecurityScheme(securitySchemeName = "httpTestScheme",
description = "user security scheme",
type = SecuritySchemeType.HTTP,
scheme = "testScheme")
},
links = {
@Link(name = "UserName",
description = "The username corresponding to provided user id",
operationId = "getUserByName",
parameters = @LinkParameter(name = "userId",
expression = "$request.path.id"))
},
callbacks = {
@Callback(name = "GetBookings",
callbackUrlExpression = "http://localhost:9080/airlines/bookings",
operations = @CallbackOperation(summary = "Retrieve all bookings for current user",
responses = {
@APIResponse(ref = "FoundBookings")
}))
},
extensions = @Extension(name = "x-components", value = "test-components")),
extensions = @Extension(name = "x-openapi-definition", value = "test-openapi-definition"))
@SecurityScheme(securitySchemeName = "airlinesRatingApp_auth",
description = "authentication needed to access Airlines app",
type = SecuritySchemeType.APIKEY,
apiKeyName = "api_key",
in = SecuritySchemeIn.HEADER,
extensions = @Extension(name = "x-security-scheme", value = "test-security-scheme"))
@SecurityScheme(securitySchemeName = "testScheme1",
type = SecuritySchemeType.APIKEY,
apiKeyName = "test1",
in = SecuritySchemeIn.HEADER)
@SecurityScheme(securitySchemeName = "testScheme2",
type = SecuritySchemeType.HTTP,
scheme = "Basic")
@Schema(name = "AirlinesRatingApp API",
description = "APIs for booking and managing air flights",
externalDocs = @ExternalDocumentation(description = "For more information, see the link.",
url = "http://exampleurl.com/schema"))
public class JAXRSApp extends Application {
@Override
public Set<Object> getSingletons() {
Set<Object> singletons = new HashSet<Object>();
singletons.add(new AirlinesResource());
singletons.add(new AvailabilityResource());
singletons.add(new BookingResource());
singletons.add(new ReviewResource());
singletons.add(new UserResource());
return singletons;
}
public static int getRandomNumber(int max, int min) {
return (new Random()).nextInt(max - min + 1) + min;
}
}