Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
package org.springdoc.core.deserializers;

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonNode;

import java.io.IOException;
import java.util.LinkedHashSet;
import java.util.Set;

/**
* Reads an OpenAPI 3.1 schema "type" that swagger-core serializes as a scalar
* {@code "type": "integer"} back into the Set<String> field, while still supporting
* the array form {@code "type": ["string","null"]}.
*/
public class TypeSetDeserializer extends JsonDeserializer<Set<String>> {

@Override
public Set<String> deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
JsonNode node = ctxt.readTree(p);
if (node == null || node.isNull()) {
return null;
}
Set<String> types = new LinkedHashSet<>();
if (node.isArray()) {
node.forEach(n -> {
if (!n.isNull()) {
types.add(n.asText());
}
});
}
else {
types.add(node.asText());
}
return types.isEmpty() ? null : types;
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package org.springdoc.core.mixins;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import org.springdoc.core.deserializers.TypeSetDeserializer;

import java.util.Set;

public interface SchemaTypeMixin {

@JsonProperty("type")
@JsonDeserialize(using = TypeSetDeserializer.class)
void setTypes(Set<String> types);

}
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,13 @@
import io.swagger.v3.core.util.Yaml;
import io.swagger.v3.core.util.Yaml31;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.JsonSchema;
import io.swagger.v3.oas.models.media.Schema;
import org.springdoc.core.mixins.SortedOpenAPIMixin;
import org.springdoc.core.mixins.SortedOpenAPIMixin31;
import org.springdoc.core.mixins.SortedSchemaMixin;
import org.springdoc.core.mixins.SortedSchemaMixin31;
import org.springdoc.core.mixins.SchemaTypeMixin;
import org.springdoc.core.properties.SpringDocConfigProperties;
import org.springdoc.core.properties.SpringDocConfigProperties.ApiDocs.OpenApiVersion;

Expand Down Expand Up @@ -74,6 +76,7 @@ public ObjectMapperProvider(SpringDocConfigProperties springDocConfigProperties)
if (openApiVersion == OpenApiVersion.OPENAPI_3_1) {
jsonMapper = Json31.mapper();
yamlMapper = Yaml31.mapper();
jsonMapper.addMixIn(JsonSchema.class, SchemaTypeMixin.class);
if (springDocConfigProperties.isUseArbitrarySchemas()) {
System.setProperty(Schema.USE_ARBITRARY_SCHEMA_PROPERTY, "true");
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
package org.springdoc.core.utils;

import io.swagger.v3.oas.models.media.JsonSchema;
import org.junit.jupiter.api.Test;
import org.springdoc.core.properties.SpringDocConfigProperties;
import org.springdoc.core.providers.ObjectMapperProvider;

import java.util.Set;

import static org.junit.jupiter.api.Assertions.*;

class SpringDocUtilsTest {

@Test
void singleTypeForJsonSchemaJsonCloning() {
SpringDocConfigProperties props = new SpringDocConfigProperties();
props.getApiDocs().setVersion(SpringDocConfigProperties.ApiDocs.OpenApiVersion.OPENAPI_3_1);
ObjectMapperProvider provider = new ObjectMapperProvider(props);

JsonSchema jsonSchema = new JsonSchema();
jsonSchema.setTypes(Set.of("integer"));

JsonSchema cloned = SpringDocUtils.cloneViaJson(jsonSchema, JsonSchema.class, provider.jsonMapper());

// The object is cloned properly, we do not get the type cast fallback
assertNotSame(jsonSchema, cloned);
assertNotNull(cloned);
assertEquals(Set.of("integer"), cloned.getTypes());
}

@Test
void nullTypeBecomesNullTypesForJsonSchemaJsonCloning() {
SpringDocConfigProperties props = new SpringDocConfigProperties();
props.getApiDocs().setVersion(SpringDocConfigProperties.ApiDocs.OpenApiVersion.OPENAPI_3_1);
ObjectMapperProvider provider = new ObjectMapperProvider(props);

JsonSchema jsonSchema = new JsonSchema();

JsonSchema cloned = SpringDocUtils.cloneViaJson(jsonSchema, JsonSchema.class, provider.jsonMapper());

// The object is cloned properly, we do not get the type cast fallback
assertNotSame(jsonSchema, cloned);
assertNotNull(cloned);
assertNull(cloned.getTypes());
}

@Test
void typeArrayIsRetainedForJsonSchemaJsonCloning() {
SpringDocConfigProperties props = new SpringDocConfigProperties();
props.getApiDocs().setVersion(SpringDocConfigProperties.ApiDocs.OpenApiVersion.OPENAPI_3_1);
ObjectMapperProvider provider = new ObjectMapperProvider(props);

JsonSchema jsonSchema = new JsonSchema();
jsonSchema.setTypes(Set.of("integer", "null"));

JsonSchema cloned = SpringDocUtils.cloneViaJson(jsonSchema, JsonSchema.class, provider.jsonMapper());

// The object is cloned properly, we do not get the type cast fallback
assertNotSame(jsonSchema, cloned);
assertNotNull(cloned);
assertEquals(Set.of("integer", "null"), cloned.getTypes());
}

}
Loading