This repository has been archived by the owner on Aug 20, 2021. It is now read-only.
/
SwaggerServiceImpl.java
312 lines (279 loc) · 12.1 KB
/
SwaggerServiceImpl.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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
/**
* Copyright (C) 2015 The Gravitee team (http://gravitee.io)
*
* 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 io.gravitee.management.service.impl;
import com.fasterxml.jackson.core.JsonProcessingException;
import io.gravitee.common.http.MediaType;
import io.gravitee.management.model.ImportSwaggerDescriptorEntity;
import io.gravitee.management.model.PageEntity;
import io.gravitee.management.model.api.NewApiEntity;
import io.gravitee.management.service.SwaggerService;
import io.gravitee.management.service.exceptions.SwaggerDescriptorException;
import io.swagger.models.Scheme;
import io.swagger.models.Swagger;
import io.swagger.parser.SwaggerCompatConverter;
import io.swagger.parser.SwaggerParser;
import io.swagger.parser.util.RemoteUrl;
import io.swagger.util.Json;
import io.swagger.util.Yaml;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.parser.OpenAPIV3Parser;
import io.swagger.v3.parser.core.models.SwaggerParseResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Map;
import java.util.stream.Collectors;
/**
* @author David BRASSELY (david.brassely at graviteesource.com)
* @author GraviteeSource Team
*/
@Component
public class SwaggerServiceImpl implements SwaggerService {
/**
* Logger.
*/
private final Logger logger = LoggerFactory.getLogger(SwaggerServiceImpl.class);
@Value("${swagger.scheme:https}")
private String defaultScheme;
static {
System.setProperty(String.format("%s.trustAll", RemoteUrl.class.getName()), Boolean.TRUE.toString());
System.setProperty(String.format("%s.trustAll", io.swagger.v3.parser.util.RemoteUrl.class.getName()), Boolean.TRUE.toString());
}
@Override
public NewApiEntity prepare(ImportSwaggerDescriptorEntity swaggerDescriptor) {
NewApiEntity apiEntity;
// try to read swagger in version 2
apiEntity = prepareV2(swaggerDescriptor);
// try to read swagger in version 3 (openAPI)
if (apiEntity == null) {
apiEntity = prepareV3(swaggerDescriptor);
}
// try to read swagger in version 1
if (apiEntity == null) {
apiEntity = prepareV1(swaggerDescriptor);
}
if (apiEntity == null) {
throw new SwaggerDescriptorException();
}
return apiEntity;
}
private NewApiEntity prepareV1(ImportSwaggerDescriptorEntity swaggerDescriptor) {
NewApiEntity apiEntity;
try {
logger.info("Loading an old Swagger descriptor from {}", swaggerDescriptor.getPayload());
if (swaggerDescriptor.getType() == ImportSwaggerDescriptorEntity.Type.INLINE) {
File temp = null;
try {
temp = createTmpSwagger1File(swaggerDescriptor.getPayload());
apiEntity = mapSwagger12ToNewApi(new SwaggerCompatConverter().read(temp.getAbsolutePath()));
} finally {
if (temp != null) {
temp.delete();
}
}
} else {
apiEntity = mapSwagger12ToNewApi(new SwaggerCompatConverter().read(swaggerDescriptor.getPayload()));
}
} catch (IOException ioe) {
logger.error("Can not read old Swagger specification", ioe);
throw new SwaggerDescriptorException();
}
return apiEntity;
}
private NewApiEntity prepareV2(ImportSwaggerDescriptorEntity swaggerDescriptor) {
NewApiEntity apiEntity;
logger.info("Trying to loading a Swagger descriptor in v2");
if (swaggerDescriptor.getType() == ImportSwaggerDescriptorEntity.Type.INLINE) {
apiEntity = mapSwagger12ToNewApi(new SwaggerParser().parse(swaggerDescriptor.getPayload()));
} else {
apiEntity = mapSwagger12ToNewApi(new SwaggerParser().read(swaggerDescriptor.getPayload()));
}
return apiEntity;
}
private NewApiEntity prepareV3(ImportSwaggerDescriptorEntity swaggerDescriptor) {
NewApiEntity apiEntity;
logger.info("Trying to loading an OpenAPI descriptor");
if (swaggerDescriptor.getType() == ImportSwaggerDescriptorEntity.Type.INLINE) {
apiEntity = mapOpenApiToNewApi(new OpenAPIV3Parser().readContents(swaggerDescriptor.getPayload()));
} else {
apiEntity = mapOpenApiToNewApi(new OpenAPIV3Parser().readWithInfo(swaggerDescriptor.getPayload(), null));
}
return apiEntity;
}
@Override
public void transform(final PageEntity page) {
if (page.getContent() != null
&& page.getConfiguration() != null
&& page.getConfiguration().get("tryItURL") != null
&& !page.getConfiguration().get("tryItURL").isEmpty()) {
Object swagger = transformV2(page.getContent(), page.getConfiguration());
if (swagger == null) {
swagger = transformV1(page.getContent(), page.getConfiguration());
}
if (swagger == null) {
swagger = transformV3(page.getContent(), page.getConfiguration());
}
if (swagger == null) {
throw new SwaggerDescriptorException();
}
if (page.getContentType().equalsIgnoreCase(MediaType.APPLICATION_JSON)) {
try {
page.setContent(Json.pretty().writeValueAsString(swagger));
} catch (JsonProcessingException e) {
logger.error("Unexpected error", e);
}
} else {
try {
page.setContent(Yaml.pretty().writeValueAsString(swagger));
} catch (JsonProcessingException e) {
logger.error("Unexpected error", e);
}
}
}
}
private File createTmpSwagger1File(String content) {
// Create temporary file for Swagger parser (only for descriptor version < 2.x)
File temp = null;
String fileName = "gio_swagger_" + System.currentTimeMillis();
BufferedWriter bw = null;
FileWriter out = null;
Swagger swagger = null;
try {
temp = File.createTempFile(fileName, ".tmp");
out = new FileWriter(temp);
bw = new BufferedWriter(out);
bw.write(content);
bw.close();
} catch (IOException ioe) {
// Fallback to the new parser
} finally {
if (bw != null) {
try {
bw.close();
} catch (IOException e) {
}
}
if (out != null) {
try {
out.close();
} catch (IOException e) {
}
}
}
return temp;
}
private Swagger transformV1(String content, Map<String, String> config) {
// Create temporary file for Swagger parser (only for descriptor version < 2.x)
File temp = null;
Swagger swagger = null;
try {
temp = createTmpSwagger1File(content);
swagger = new SwaggerCompatConverter().read(temp.getAbsolutePath());
if (swagger != null && config != null && config.get("tryItURL") != null) {
URI newURI = URI.create(config.get("tryItURL"));
swagger.setSchemes(Collections.singletonList(Scheme.forValue(newURI.getScheme())));
swagger.setHost((newURI.getPort() != -1) ? newURI.getHost() + ':' + newURI.getPort() : newURI.getHost());
swagger.setBasePath((newURI.getRawPath().isEmpty()) ? "/" : newURI.getRawPath());
}
} catch (IOException ioe) {
// Fallback to the new parser
} finally {
if (temp != null) {
temp.delete();
}
}
return swagger;
}
private Swagger transformV2(String content, Map<String, String> config) {
Swagger swagger = new SwaggerParser().parse(content);
if (swagger != null && config != null && config.get("tryItURL") != null) {
URI newURI = URI.create(config.get("tryItURL"));
swagger.setSchemes(Collections.singletonList(Scheme.forValue(newURI.getScheme())));
swagger.setHost((newURI.getPort() != -1) ? newURI.getHost() + ':' + newURI.getPort() : newURI.getHost());
swagger.setBasePath((newURI.getRawPath().isEmpty()) ? "/" : newURI.getRawPath());
}
return swagger;
}
private OpenAPI transformV3(String content, Map<String, String> config) {
SwaggerParseResult result = new OpenAPIV3Parser().readContents(content, null, null);
if (result != null && config != null && config.get("tryItURL") != null) {
URI newURI = URI.create(config.get("tryItURL"));
result.getOpenAPI().getServers().forEach(server -> {
try {
server.setUrl(new URI(newURI.getScheme(),
newURI.getUserInfo(),
newURI.getHost(),
newURI.getPort(),
newURI.getPath(),
newURI.getQuery(),
newURI.getFragment()).toString());
} catch (URISyntaxException e) {
logger.error(e.getMessage(), e);
}
});
}
if (result != null) {
return result.getOpenAPI();
} else {
return null;
}
}
private NewApiEntity mapSwagger12ToNewApi(Swagger swagger) {
if (swagger == null || swagger.getInfo() == null) {
return null;
}
NewApiEntity apiEntity = new NewApiEntity();
apiEntity.setName(swagger.getInfo().getTitle());
apiEntity.setDescription(swagger.getInfo().getDescription());
apiEntity.setVersion(swagger.getInfo().getVersion());
String scheme = (swagger.getSchemes() == null || swagger.getSchemes().isEmpty()) ? defaultScheme :
swagger.getSchemes().iterator().next().toValue();
apiEntity.setEndpoint(scheme + "://" + swagger.getHost() + swagger.getBasePath());
apiEntity.setPaths(new ArrayList<>(
swagger.getPaths().keySet()
.stream()
.map(path -> path.replaceAll("\\{(.[^/]*)\\}", ":$1"))
.collect(Collectors.toList())));
return apiEntity;
}
private NewApiEntity mapOpenApiToNewApi(SwaggerParseResult swagger) {
if (swagger == null || swagger.getOpenAPI() == null || swagger.getOpenAPI().getInfo() == null) {
return null;
}
NewApiEntity apiEntity = new NewApiEntity();
apiEntity.setName(swagger.getOpenAPI().getInfo().getTitle());
apiEntity.setDescription(swagger.getOpenAPI().getInfo().getDescription());
apiEntity.setVersion(swagger.getOpenAPI().getInfo().getVersion());
if (!swagger.getOpenAPI().getServers().isEmpty()) {
apiEntity.setEndpoint(swagger.getOpenAPI().getServers().get(0).getUrl());
}
apiEntity.setPaths(new ArrayList<>(
swagger.getOpenAPI().getPaths().keySet()
.stream()
.map(path -> path.replaceAll("\\{(.[^/]*)\\}", ":$1"))
.collect(Collectors.toList())));
return apiEntity;
}
}