Malformed api-docs JSON when StringHttpMessageConverter is not active. Fixes springdoc#2051

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

@@ -1236,7 +1236,7 @@ protected void initOpenAPIBuilder(Locale locale) {
  * @return the string
  * @throws JsonProcessingException the json processing exception
  */
-protected String writeYamlValue(OpenAPI openAPI) throws JsonProcessingException {
+protected byte[] writeYamlValue(OpenAPI openAPI) throws JsonProcessingException {
 String result;
 ObjectMapper objectMapper = springDocProviders.yamlMapper();
 if (springDocConfigProperties.isWriterWithOrderByKeys())
@@ -1247,7 +1247,7 @@ protected String writeYamlValue(OpenAPI openAPI) throws JsonProcessingException
 result = objectMapper.writerFor(OpenAPI.class).writeValueAsString(openAPI);
 else
 result = objectMapper.writerWithDefaultPrettyPrinter().forType(OpenAPI.class).writeValueAsString(openAPI);
-return result;
+return result.getBytes(StandardCharsets.UTF_8);
 }
 
 /**
@@ -1307,7 +1307,7 @@ protected boolean isActuatorRestController(String operationPath, HandlerMethod h
  * @return the string
  * @throws JsonProcessingException the json processing exception
  */
-protected String writeJsonValue(OpenAPI openAPI) throws JsonProcessingException {
+protected byte[] writeJsonValue(OpenAPI openAPI) throws JsonProcessingException {
 String result;
 ObjectMapper objectMapper = springDocProviders.jsonMapper();
 if (springDocConfigProperties.isWriterWithOrderByKeys())
@@ -1316,7 +1316,7 @@ protected String writeJsonValue(OpenAPI openAPI) throws JsonProcessingException
 result = objectMapper.writerFor(OpenAPI.class).writeValueAsString(openAPI);
 else
 result = objectMapper.writerWithDefaultPrettyPrinter().forType(OpenAPI.class).writeValueAsString(openAPI);
-return result;
+return result.getBytes(StandardCharsets.UTF_8);
 }
 
 /**

springdoc-openapi-common/src/main/java/org/springdoc/core/converters/JavaTypeToIgnoreConverter.java

@@ -29,7 +29,6 @@
 import io.swagger.v3.core.converter.ModelConverter;
 import io.swagger.v3.core.converter.ModelConverterContext;
 import io.swagger.v3.oas.models.media.Schema;
-import org.springdoc.core.AbstractRequestService;
 import org.springdoc.core.providers.ObjectMapperProvider;
 
 /**

springdoc-openapi-kotlin/src/test/kotlin/test/org/springdoc/api/app7/ExampleController.kt

@@ -1,10 +1,7 @@
 package test.org.springdoc.api.app7
 
 import io.swagger.v3.oas.annotations.Parameter
-import io.swagger.v3.oas.annotations.parameters.RequestBody
 import org.springframework.web.bind.annotation.GetMapping
-import org.springframework.web.bind.annotation.PostMapping
-import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RequestParam
 import org.springframework.web.bind.annotation.RestController
 

springdoc-openapi-kotlin/src/test/kotlin/test/org/springdoc/api/app9/DemoController.kt

@@ -1,7 +1,9 @@
 package test.org.springdoc.api.app9
 
 import io.swagger.v3.oas.annotations.media.Schema
-import org.springframework.web.bind.annotation.*
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
 
 @RestController
 @RequestMapping("/api/demo")

springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/MultipleOpenApiActuatorResource.java

@@ -83,7 +83,7 @@ public MultipleOpenApiActuatorResource(List<GroupedOpenApi> groupedOpenApis, Obj
  */
 @Operation(hidden = true)
 @GetMapping(value = "/{group}", produces = MediaType.APPLICATION_JSON_VALUE)
-public Mono<String> openapiJson(ServerHttpRequest
+public Mono<byte[]> openapiJson(ServerHttpRequest
 serverHttpRequest, @Value(API_DOCS_URL) String apiDocsUrl,
 @PathVariable String group, Locale locale)
 throws JsonProcessingException {
@@ -102,7 +102,7 @@ public Mono<String> openapiJson(ServerHttpRequest
  */
 @Operation(hidden = true)
 @GetMapping(value = "/{group}/yaml", produces = APPLICATION_OPENAPI_YAML)
-public Mono<String> openapiYaml(ServerHttpRequest serverHttpRequest,
+public Mono<byte[]> openapiYaml(ServerHttpRequest serverHttpRequest,
 @Value(DEFAULT_API_DOCS_URL_YAML) String apiDocsUrl, @PathVariable String
 group, Locale locale) throws JsonProcessingException {
 return getOpenApiResourceOrThrow(group).openapiYaml(serverHttpRequest, apiDocsUrl + DEFAULT_PATH_SEPARATOR + group, locale);

springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/MultipleOpenApiWebFluxResource.java

@@ -82,7 +82,7 @@ public MultipleOpenApiWebFluxResource(List<GroupedOpenApi> groupedOpenApis, Obje
  */
 @Operation(hidden = true)
 @GetMapping(value = API_DOCS_URL + "/{group}", produces = MediaType.APPLICATION_JSON_VALUE)
-public Mono<String> openapiJson(ServerHttpRequest
+public Mono<byte[]> openapiJson(ServerHttpRequest
 serverHttpRequest, @Value(API_DOCS_URL) String apiDocsUrl, @PathVariable String
 group, Locale locale) throws JsonProcessingException {
 return getOpenApiResourceOrThrow(group).openapiJson(serverHttpRequest, apiDocsUrl + DEFAULT_PATH_SEPARATOR + group, locale);
@@ -100,7 +100,7 @@ public Mono<String> openapiJson(ServerHttpRequest
  */
 @Operation(hidden = true)
 @GetMapping(value = DEFAULT_API_DOCS_URL_YAML + "/{group}", produces = APPLICATION_OPENAPI_YAML)
-public Mono<String> openapiYaml(ServerHttpRequest serverHttpRequest,
+public Mono<byte[]> openapiYaml(ServerHttpRequest serverHttpRequest,
 @Value(DEFAULT_API_DOCS_URL_YAML) String apiDocsUrl, @PathVariable String
 group, Locale locale) throws JsonProcessingException {
 return getOpenApiResourceOrThrow(group).openapiYaml(serverHttpRequest, apiDocsUrl + DEFAULT_PATH_SEPARATOR + group, locale);

springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/OpenApiActuatorResource.java

@@ -108,7 +108,7 @@ public OpenApiActuatorResource(ObjectFactory<OpenAPIService> openAPIBuilderObjec
  */
 @Operation(hidden = true)
 @GetMapping(value = DEFAULT_PATH_SEPARATOR, produces = MediaType.APPLICATION_JSON_VALUE)
-public Mono<String> openapiJson(ServerHttpRequest serverHttpRequest, Locale locale)
+public Mono<byte[]> openapiJson(ServerHttpRequest serverHttpRequest, Locale locale)
 throws JsonProcessingException {
 return super.openapiJson(serverHttpRequest, EMPTY, locale);
 }
@@ -124,7 +124,7 @@ public Mono<String> openapiJson(ServerHttpRequest serverHttpRequest, Locale loca
  */
 @Operation(hidden = true)
 @GetMapping(value = DEFAULT_YAML_API_DOCS_ACTUATOR_PATH, produces = APPLICATION_OPENAPI_YAML)
-public Mono<String> openapiYaml(ServerHttpRequest serverHttpRequest, Locale locale)
+public Mono<byte[]> openapiYaml(ServerHttpRequest serverHttpRequest, Locale locale)
 throws JsonProcessingException {
 return super.openapiYaml(serverHttpRequest, YAML, locale);
 }

springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/OpenApiResource.java

@@ -130,7 +130,7 @@ public OpenApiResource(ObjectFactory<OpenAPIService> openAPIBuilderObjectFactory
  * @return the mono
  * @throws JsonProcessingException the json processing exception
  */
-protected Mono<String> openapiJson(ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale)
+protected Mono<byte[]> openapiJson(ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale)
 throws JsonProcessingException {
 calculateServerUrl(serverHttpRequest, apiDocsUrl, locale);
 OpenAPI openAPI = this.getOpenApi(locale);
@@ -146,7 +146,7 @@ protected Mono<String> openapiJson(ServerHttpRequest serverHttpRequest, String a
  * @return the mono
  * @throws JsonProcessingException the json processing exception
  */
-protected Mono<String> openapiYaml(ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale)
+protected Mono<byte[]> openapiYaml(ServerHttpRequest serverHttpRequest, String apiDocsUrl, Locale locale)
 throws JsonProcessingException {
 calculateServerUrl(serverHttpRequest, apiDocsUrl, locale);
 OpenAPI openAPI = this.getOpenApi(locale);

springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/OpenApiWebfluxResource.java

@@ -112,7 +112,7 @@ public OpenApiWebfluxResource(ObjectFactory<OpenAPIService> openAPIBuilderObject
 @Operation(hidden = true)
 @GetMapping(value = API_DOCS_URL, produces = MediaType.APPLICATION_JSON_VALUE)
 @Override
-public Mono<String> openapiJson(ServerHttpRequest serverHttpRequest, @Value(API_DOCS_URL) String apiDocsUrl, Locale locale)
+public Mono<byte[]> openapiJson(ServerHttpRequest serverHttpRequest, @Value(API_DOCS_URL) String apiDocsUrl, Locale locale)
 throws JsonProcessingException {
 return super.openapiJson(serverHttpRequest, apiDocsUrl, locale);
 }
@@ -129,7 +129,7 @@ public Mono<String> openapiJson(ServerHttpRequest serverHttpRequest, @Value(API_
 @Operation(hidden = true)
 @GetMapping(value = DEFAULT_API_DOCS_URL_YAML, produces = APPLICATION_OPENAPI_YAML)
 @Override
-public Mono<String> openapiYaml(ServerHttpRequest serverHttpRequest,
+public Mono<byte[]> openapiYaml(ServerHttpRequest serverHttpRequest,
 @Value(DEFAULT_API_DOCS_URL_YAML) String apiDocsUrl, Locale locale) throws JsonProcessingException {
 return super.openapiYaml(serverHttpRequest, apiDocsUrl, locale);
 }

springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app81/SpringDocApp81Test.java

@@ -23,6 +23,7 @@
 package test.org.springdoc.api.app81;
 
 import java.net.URI;
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.Comparator;
 import java.util.List;
@@ -69,7 +70,9 @@ public void shouldGenerateOperationIdsDeterministically() throws Exception {
 when(request.getURI()).thenReturn(URI.create("http://localhost"));
 
 String expected = getContent("results/app81.json");
-String openApi = resource.openapiJson(request, "", Locale.US).block();
+byte[] openApiBytes =resource.openapiJson(request, "", Locale.US).block();
+String openApi = new String(openApiBytes, StandardCharsets.UTF_8); // for UTF-8 encoding
+
 assertEquals(expected, openApi, true);
 }