Skip to content

Commit 25670d0

Browse files
author
bnasslahsen
committed
code cleanup
1 parent 4d31bd9 commit 25670d0

File tree

5 files changed

+54
-76
lines changed

5 files changed

+54
-76
lines changed

‎springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestBuilder.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ public Operation build(Components components, HandlerMethod handlerMethod, Reque
174174

175175
if (!isParamToIgnore(parameters[i].getParameter())) {
176176
ParameterInfo parameterInfo = new ParameterInfo(pName, parameters[i], parameter, i);
177-
parameter = buildParams(parameterInfo, components, handlerMethod, requestMethod,
177+
parameter = buildParams(parameterInfo, components, requestMethod,
178178
methodAttributes.getJsonViewAnnotation());
179179
// Merge with the operation parameters
180180
parameter = parameterBuilder.mergeParameter(operationParameters, parameter);
@@ -184,7 +184,7 @@ public Operation build(Components components, HandlerMethod handlerMethod, Reque
184184
else if (!RequestMethod.GET.equals(requestMethod)) {
185185
if (operation.getRequestBody() != null)
186186
requestBodyInfo.setRequestBody(operation.getRequestBody());
187-
requestBodyBuilder.calculateRequestBodyInfo(components, handlerMethod, methodAttributes, i,
187+
requestBodyBuilder.calculateRequestBodyInfo(components, methodAttributes,
188188
parameterInfo, requestBodyInfo);
189189
applyBeanValidatorAnnotations(requestBodyInfo.getRequestBody(), Arrays.asList(parameters[i].getParameterAnnotations()));
190190
}
@@ -223,7 +223,7 @@ private LinkedHashMap<String, Parameter> getParameterLinkedHashMap(Components co
223223

224224
for (Map.Entry<String, String> entry : methodAttributes.getHeaders().entrySet()) {
225225
Parameter parameter = new Parameter().in(ParameterIn.HEADER.toString()).name(entry.getKey()).schema(new StringSchema().addEnumItem(entry.getValue()));
226-
if (map.containsKey(entry.getKey())){
226+
if (map.containsKey(entry.getKey())) {
227227
parameter = map.get(entry.getKey());
228228
parameter.getSchema().addEnumItemObject(entry.getValue());
229229
parameter.setSchema(parameter.getSchema());
@@ -262,15 +262,14 @@ private boolean isValidParameter(Parameter parameter) {
262262
return parameter != null && (parameter.getName() != null || parameter.get$ref() != null);
263263
}
264264

265-
private Parameter buildParams(ParameterInfo parameterInfo, Components components, HandlerMethod handlerMethod,
265+
private Parameter buildParams(ParameterInfo parameterInfo, Components components,
266266
RequestMethod requestMethod, JsonView jsonView) {
267267
MethodParameter methodParameter = parameterInfo.getMethodParameter();
268-
int index = parameterInfo.getIndex();
269268

270269
RequestHeader requestHeader = methodParameter.getParameterAnnotation(RequestHeader.class);
271270
RequestParam requestParam = methodParameter.getParameterAnnotation(RequestParam.class);
272271
PathVariable pathVar = methodParameter.getParameterAnnotation(PathVariable.class);
273-
CookieValue cookieValue = methodParameter.getParameterAnnotation(CookieValue.class);
272+
CookieValue cookieValue = methodParameter.getParameterAnnotation(CookieValue.class);
274273

275274
Parameter parameter = null;
276275
RequestInfo requestInfo;

‎springdoc-openapi-common/src/main/java/org/springdoc/core/RequestBodyBuilder.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@
3131

3232
import org.springframework.core.MethodParameter;
3333
import org.springframework.web.bind.annotation.RequestPart;
34-
import org.springframework.web.method.HandlerMethod;
3534

3635
public class RequestBodyBuilder {
3736

@@ -85,8 +84,8 @@ public Optional<RequestBody> buildRequestBodyFromDoc(
8584
return Optional.of(requestBodyObject);
8685
}
8786

88-
public void calculateRequestBodyInfo(Components components, HandlerMethod handlerMethod,
89-
MethodAttributes methodAttributes, int i, ParameterInfo parameterInfo, RequestBodyInfo requestBodyInfo) {
87+
public void calculateRequestBodyInfo(Components components, MethodAttributes methodAttributes,
88+
ParameterInfo parameterInfo, RequestBodyInfo requestBodyInfo) {
9089
RequestBody requestBody = requestBodyInfo.getRequestBody();
9190
MethodParameter methodParameter = parameterInfo.getMethodParameter();
9291
// Get it from parameter level, if not present

‎springdoc-openapi-common/src/main/java/org/springdoc/ui/AbstractSwaggerIndexTransformer.java

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
package org.springdoc.ui;
2+
3+
import java.io.ByteArrayOutputStream;
4+
import java.io.IOException;
5+
import java.io.InputStream;
6+
import java.nio.charset.StandardCharsets;
7+
8+
import com.fasterxml.jackson.core.JsonProcessingException;
9+
import com.fasterxml.jackson.databind.ObjectMapper;
10+
import org.springdoc.core.SwaggerUiOAuthProperties;
11+
12+
public class AbstractSwaggerIndexTransformer {
13+
14+
protected SwaggerUiOAuthProperties swaggerUiOAuthProperties;
15+
16+
protected ObjectMapper objectMapper;
17+
18+
public AbstractSwaggerIndexTransformer(SwaggerUiOAuthProperties swaggerUiOAuthProperties, ObjectMapper objectMapper) {
19+
this.swaggerUiOAuthProperties = swaggerUiOAuthProperties;
20+
this.objectMapper = objectMapper;
21+
}
22+
23+
protected String addInitOauth(String html) throws JsonProcessingException {
24+
StringBuilder stringBuilder = new StringBuilder("window.ui = ui\n");
25+
stringBuilder.append("ui.initOAuth(\n");
26+
String json = objectMapper.writeValueAsString(swaggerUiOAuthProperties.getConfigParameters());
27+
stringBuilder.append(json);
28+
stringBuilder.append(")");
29+
return html.replace("window.ui = ui", stringBuilder.toString());
30+
}
31+
32+
protected String readFullyAsString(InputStream inputStream)
33+
throws IOException {
34+
ByteArrayOutputStream baos = new ByteArrayOutputStream();
35+
byte[] buffer = new byte[1024];
36+
int length;
37+
while ((length = inputStream.read(buffer)) != -1) {
38+
baos.write(buffer, 0, length);
39+
}
40+
return baos.toString(StandardCharsets.UTF_8.name());
41+
}
42+
}

‎springdoc-openapi-ui/src/main/java/org/springdoc/ui/SwaggerIndexTransformer.java

Lines changed: 2 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,10 @@
1818

1919
package org.springdoc.ui;
2020

21-
import java.io.ByteArrayOutputStream;
2221
import java.io.IOException;
23-
import java.io.InputStream;
24-
import java.nio.charset.StandardCharsets;
2522

2623
import javax.servlet.http.HttpServletRequest;
2724

28-
import com.fasterxml.jackson.core.JsonProcessingException;
2925
import com.fasterxml.jackson.databind.ObjectMapper;
3026
import org.springdoc.core.SwaggerUiOAuthProperties;
3127

@@ -36,15 +32,10 @@
3632
import org.springframework.web.servlet.resource.ResourceTransformerChain;
3733
import org.springframework.web.servlet.resource.TransformedResource;
3834

39-
public class SwaggerIndexTransformer implements ResourceTransformer {
40-
41-
private SwaggerUiOAuthProperties swaggerUiOAuthProperties;
42-
43-
private ObjectMapper objectMapper;
35+
public class SwaggerIndexTransformer extends AbstractSwaggerIndexTransformer implements ResourceTransformer {
4436

4537
public SwaggerIndexTransformer(SwaggerUiOAuthProperties swaggerUiOAuthProperties, ObjectMapper objectMapper) {
46-
this.swaggerUiOAuthProperties = swaggerUiOAuthProperties;
47-
this.objectMapper = objectMapper;
38+
super(swaggerUiOAuthProperties, objectMapper);
4839
}
4940

5041
@Override
@@ -62,23 +53,4 @@ public Resource transform(HttpServletRequest request, Resource resource,
6253
}
6354
}
6455

65-
private String addInitOauth(String html) throws JsonProcessingException {
66-
StringBuilder stringBuilder = new StringBuilder("window.ui = ui\n");
67-
stringBuilder.append("ui.initOAuth(\n");
68-
String json = objectMapper.writeValueAsString(swaggerUiOAuthProperties.getConfigParameters());
69-
stringBuilder.append(json);
70-
stringBuilder.append(")");
71-
return html.replace("window.ui = ui", stringBuilder.toString());
72-
}
73-
74-
private String readFullyAsString(InputStream inputStream)
75-
throws IOException {
76-
ByteArrayOutputStream baos = new ByteArrayOutputStream();
77-
byte[] buffer = new byte[1024];
78-
int length;
79-
while ((length = inputStream.read(buffer)) != -1) {
80-
baos.write(buffer, 0, length);
81-
}
82-
return baos.toString(StandardCharsets.UTF_8.name());
83-
}
8456
}

‎springdoc-openapi-webflux-ui/src/main/java/org/springdoc/ui/SwaggerIndexTransformer.java

Lines changed: 3 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,7 @@
1818

1919
package org.springdoc.ui;
2020

21-
import java.io.ByteArrayOutputStream;
22-
import java.io.IOException;
23-
import java.io.InputStream;
24-
import java.nio.charset.StandardCharsets;
25-
26-
import com.fasterxml.jackson.core.JsonProcessingException;
2721
import com.fasterxml.jackson.databind.ObjectMapper;
28-
import org.slf4j.Logger;
29-
import org.slf4j.LoggerFactory;
3022
import org.springdoc.core.SwaggerUiOAuthProperties;
3123
import reactor.core.publisher.Mono;
3224

@@ -38,17 +30,10 @@
3830
import org.springframework.web.reactive.resource.TransformedResource;
3931
import org.springframework.web.server.ServerWebExchange;
4032

41-
public class SwaggerIndexTransformer implements ResourceTransformer {
42-
43-
private static final Logger LOGGER = LoggerFactory.getLogger(SwaggerIndexTransformer.class);
44-
45-
private SwaggerUiOAuthProperties swaggerUiOAuthProperties;
46-
47-
private ObjectMapper objectMapper;
33+
public class SwaggerIndexTransformer extends AbstractSwaggerIndexTransformer implements ResourceTransformer {
4834

4935
public SwaggerIndexTransformer(SwaggerUiOAuthProperties swaggerUiOAuthProperties, ObjectMapper objectMapper) {
50-
this.swaggerUiOAuthProperties = swaggerUiOAuthProperties;
51-
this.objectMapper = objectMapper;
36+
super(swaggerUiOAuthProperties, objectMapper);
5237
}
5338

5439
@Override
@@ -67,28 +52,9 @@ public Mono<Resource> transform(ServerWebExchange serverWebExchange, Resource re
6752
}
6853
}
6954
catch (Exception e) {
70-
throw new RuntimeException(e);
55+
throw new RuntimeException("Failed to transform Index", e);
7156
}
7257
}
7358

74-
private String addInitOauth(String html) throws JsonProcessingException {
75-
StringBuilder stringBuilder = new StringBuilder("window.ui = ui\n");
76-
stringBuilder.append("ui.initOAuth(\n");
77-
String json = objectMapper.writeValueAsString(swaggerUiOAuthProperties.getConfigParameters());
78-
stringBuilder.append(json);
79-
stringBuilder.append(")");
80-
return html.replace("window.ui = ui", stringBuilder.toString());
81-
}
82-
83-
private String readFullyAsString(InputStream inputStream)
84-
throws IOException {
85-
ByteArrayOutputStream baos = new ByteArrayOutputStream();
86-
byte[] buffer = new byte[1024];
87-
int length;
88-
while ((length = inputStream.read(buffer)) != -1) {
89-
baos.write(buffer, 0, length);
90-
}
91-
return baos.toString(StandardCharsets.UTF_8.name());
92-
}
9359

9460
}

0 commit comments

Comments
 (0)