Skip to content

Commit 3ae7763

Browse files
sahil-ramagirisahil-ramagiri
committed
Do not require JsonSubType annotation for sealed classes.
1 parent 174e4d8 commit 3ae7763

File tree

10 files changed

+746
-1
lines changed

10 files changed

+746
-1
lines changed

‎springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocConfiguration.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -423,7 +423,7 @@ SpringDocProviders springDocProviders(Optional<ActuatorProvider> actuatorProvide
423423
Optional<RepositoryRestResourceProvider> repositoryRestResourceProvider, Optional<RouterFunctionProvider> routerFunctionProvider,
424424
Optional<SpringWebProvider> springWebProvider,
425425
ObjectMapperProvider objectMapperProvider) {
426-
objectMapperProvider.jsonMapper().registerModule(new SpringDocRequiredModule());
426+
objectMapperProvider.jsonMapper().registerModules(new SpringDocRequiredModule(), new SpringDocSealedClassModule());
427427
return new SpringDocProviders(actuatorProvider, springCloudFunctionProvider, springSecurityOAuth2Provider, repositoryRestResourceProvider, routerFunctionProvider, springWebProvider, objectMapperProvider);
428428
}
429429

‎springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocSealedClassModule.java

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
/*
2+
*
3+
* *
4+
* * *
5+
* * * * Copyright 2025 the original author or authors.
6+
* * * *
7+
* * * * Licensed under the Apache License, Version 2.0 (the "License");
8+
* * * * you may not use this file except in compliance with the License.
9+
* * * * You may obtain a copy of the License at
10+
* * * *
11+
* * * * https://www.apache.org/licenses/LICENSE-2.0
12+
* * * *
13+
* * * * Unless required by applicable law or agreed to in writing, software
14+
* * * * distributed under the License is distributed on an "AS IS" BASIS,
15+
* * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
* * * * See the License for the specific language governing permissions and
17+
* * * * limitations under the License.
18+
* * *
19+
* *
20+
*
21+
*/
22+
23+
package org.springdoc.core.configuration;
24+
25+
import com.fasterxml.jackson.databind.introspect.Annotated;
26+
import com.fasterxml.jackson.databind.jsontype.NamedType;
27+
import com.fasterxml.jackson.databind.module.SimpleModule;
28+
import io.swagger.v3.core.jackson.SwaggerAnnotationIntrospector;
29+
import java.util.ArrayList;
30+
import java.util.Arrays;
31+
import java.util.List;
32+
33+
/**
34+
* The type Spring doc sealed class module.
35+
*
36+
* @author sahil-ramagiri
37+
*/
38+
public class SpringDocSealedClassModule extends SimpleModule {
39+
40+
@Override
41+
public void setupModule(SetupContext context) {
42+
context.insertAnnotationIntrospector(new RespectSealedClassAnnotationIntrospector());
43+
}
44+
45+
/**
46+
* The type sealed class annotation introspector.
47+
*/
48+
private static class RespectSealedClassAnnotationIntrospector extends SwaggerAnnotationIntrospector {
49+
50+
@Override
51+
public List<NamedType> findSubtypes(Annotated annotated) {
52+
ArrayList<NamedType> subTypes = new ArrayList<>();
53+
54+
if (annotated.getAnnotated() instanceof Class<?> clazz && clazz.isSealed()) {
55+
Class<?>[] permittedSubClasses = clazz.getPermittedSubclasses();
56+
if (permittedSubClasses.length > 0) {
57+
Arrays.stream(permittedSubClasses).map(NamedType::new).forEach(subTypes::add);
58+
}
59+
}
60+
61+
return subTypes;
62+
}
63+
}
64+
}

‎springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app238/AbstractParent.java

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
/*
2+
*
3+
* *
4+
* * *
5+
* * * *
6+
* * * * * Copyright 2025 the original author or authors.
7+
* * * * *
8+
* * * * * Licensed under the Apache License, Version 2.0 (the "License");
9+
* * * * * you may not use this file except in compliance with the License.
10+
* * * * * You may obtain a copy of the License at
11+
* * * * *
12+
* * * * * https://www.apache.org/licenses/LICENSE-2.0
13+
* * * * *
14+
* * * * * Unless required by applicable law or agreed to in writing, software
15+
* * * * * distributed under the License is distributed on an "AS IS" BASIS,
16+
* * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17+
* * * * * See the License for the specific language governing permissions and
18+
* * * * * limitations under the License.
19+
* * * *
20+
* * *
21+
* *
22+
*
23+
*/
24+
25+
package test.org.springdoc.api.v30.app238;
26+
27+
28+
import com.fasterxml.jackson.annotation.JsonTypeInfo;
29+
import com.fasterxml.jackson.annotation.JsonTypeInfo.Id;
30+
31+
@JsonTypeInfo(use = Id.NAME, property = "type")
32+
public abstract sealed class AbstractParent {
33+
private int id;
34+
35+
public int getId() {
36+
return id;
37+
}
38+
39+
public void setId(int id) {
40+
this.id = id;
41+
}
42+
}
43+
44+
final class ChildOfAbstract1 extends AbstractParent {
45+
private String abstrachChild1Param;
46+
47+
public String getAbstrachChild1Param() {
48+
return abstrachChild1Param;
49+
}
50+
51+
public void setAbstrachChild1Param(String abstrachChild1Param) {
52+
this.abstrachChild1Param = abstrachChild1Param;
53+
}
54+
}
55+
56+
final class ChildOfAbstract2 extends AbstractParent {
57+
private String abstractChild2Param;
58+
59+
public String getAbstractChild2Param() {
60+
return abstractChild2Param;
61+
}
62+
63+
public void setAbstractChild2Param(String abstractChild2Param) {
64+
this.abstractChild2Param = abstractChild2Param;
65+
}
66+
}

‎springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app238/ConcreteParent.java

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
/*
2+
*
3+
* *
4+
* * *
5+
* * * *
6+
* * * * * Copyright 2025 the original author or authors.
7+
* * * * *
8+
* * * * * Licensed under the Apache License, Version 2.0 (the "License");
9+
* * * * * you may not use this file except in compliance with the License.
10+
* * * * * You may obtain a copy of the License at
11+
* * * * *
12+
* * * * * https://www.apache.org/licenses/LICENSE-2.0
13+
* * * * *
14+
* * * * * Unless required by applicable law or agreed to in writing, software
15+
* * * * * distributed under the License is distributed on an "AS IS" BASIS,
16+
* * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17+
* * * * * See the License for the specific language governing permissions and
18+
* * * * * limitations under the License.
19+
* * * *
20+
* * *
21+
* *
22+
*
23+
*/
24+
25+
package test.org.springdoc.api.v30.app238;
26+
27+
28+
import com.fasterxml.jackson.annotation.JsonTypeInfo;
29+
import com.fasterxml.jackson.annotation.JsonTypeInfo.Id;
30+
31+
@JsonTypeInfo(use = Id.NAME, property = "type")
32+
public sealed class ConcreteParent {
33+
private int id;
34+
35+
public int getId() {
36+
return id;
37+
}
38+
39+
public void setId(int id) {
40+
this.id = id;
41+
}
42+
}
43+
44+
final class ChildOfConcrete1 extends ConcreteParent {
45+
private String concreteChild1Param;
46+
47+
public String getConcreteChild1Param() {
48+
return concreteChild1Param;
49+
}
50+
51+
public void setConcreteChild1Param(String concreteChild1Param) {
52+
this.concreteChild1Param = concreteChild1Param;
53+
}
54+
}
55+
56+
final class ChildOfConcrete2 extends ConcreteParent {
57+
private String concreteChild2Param;
58+
59+
public String getConcreteChild2Param() {
60+
return concreteChild2Param;
61+
}
62+
63+
public void setConcreteChild2Param(String concreteChild2Param) {
64+
this.concreteChild2Param = concreteChild2Param;
65+
}
66+
}

‎springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app238/Controller.java

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
/*
2+
*
3+
* *
4+
* * *
5+
* * * *
6+
* * * * * Copyright 2025 the original author or authors.
7+
* * * * *
8+
* * * * * Licensed under the Apache License, Version 2.0 (the "License");
9+
* * * * * you may not use this file except in compliance with the License.
10+
* * * * * You may obtain a copy of the License at
11+
* * * * *
12+
* * * * * https://www.apache.org/licenses/LICENSE-2.0
13+
* * * * *
14+
* * * * * Unless required by applicable law or agreed to in writing, software
15+
* * * * * distributed under the License is distributed on an "AS IS" BASIS,
16+
* * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17+
* * * * * See the License for the specific language governing permissions and
18+
* * * * * limitations under the License.
19+
* * * *
20+
* * *
21+
* *
22+
*
23+
*/
24+
25+
package test.org.springdoc.api.v30.app238;
26+
27+
import java.util.List;
28+
29+
import org.springframework.web.bind.annotation.PostMapping;
30+
import org.springframework.web.bind.annotation.RequestBody;
31+
import org.springframework.web.bind.annotation.RequestMapping;
32+
import org.springframework.web.bind.annotation.RestController;
33+
34+
@RestController
35+
@RequestMapping("class-hierarchy")
36+
public class Controller {
37+
@PostMapping("abstract-parent")
38+
public Response abstractParent(@RequestBody AbstractParent payload) {
39+
return null;
40+
}
41+
42+
@PostMapping("concrete-parent")
43+
public Response concreteParent(@RequestBody ConcreteParent payload) {
44+
return null;
45+
}
46+
}
47+
48+
class Response {
49+
AbstractParent abstractParent;
50+
51+
List<ConcreteParent> concreteParents;
52+
53+
public AbstractParent getAbstractParent() {
54+
return abstractParent;
55+
}
56+
57+
public void setAbstractParent(AbstractParent abstractParent) {
58+
this.abstractParent = abstractParent;
59+
}
60+
61+
public List<ConcreteParent> getConcreteParents() {
62+
return concreteParents;
63+
}
64+
65+
public void setConcreteParents(List<ConcreteParent> concreteParents) {
66+
this.concreteParents = concreteParents;
67+
}
68+
}

‎springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app238/SpringDocApp238Test.java

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
/*
2+
*
3+
* *
4+
* * *
5+
* * * *
6+
* * * * * Copyright 2025 the original author or authors.
7+
* * * * *
8+
* * * * * Licensed under the Apache License, Version 2.0 (the "License");
9+
* * * * * you may not use this file except in compliance with the License.
10+
* * * * * You may obtain a copy of the License at
11+
* * * * *
12+
* * * * * https://www.apache.org/licenses/LICENSE-2.0
13+
* * * * *
14+
* * * * * Unless required by applicable law or agreed to in writing, software
15+
* * * * * distributed under the License is distributed on an "AS IS" BASIS,
16+
* * * * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17+
* * * * * See the License for the specific language governing permissions and
18+
* * * * * limitations under the License.
19+
* * * *
20+
* * *
21+
* *
22+
*
23+
*/
24+
25+
package test.org.springdoc.api.v30.app238;
26+
27+
import test.org.springdoc.api.v30.AbstractSpringDocV30Test;
28+
29+
import org.springframework.boot.autoconfigure.SpringBootApplication;
30+
31+
32+
public class SpringDocApp238Test extends AbstractSpringDocV30Test {
33+
34+
@SpringBootApplication
35+
static class SpringDocTestApp {}
36+
}

‎springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app239/HelloController.java

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
package test.org.springdoc.api.v30.app239;
2+
3+
4+
import com.fasterxml.jackson.annotation.JsonTypeInfo;
5+
import io.swagger.v3.oas.annotations.media.Schema;
6+
7+
import org.springframework.web.bind.annotation.PostMapping;
8+
import org.springframework.web.bind.annotation.RequestBody;
9+
import org.springframework.web.bind.annotation.RestController;
10+
11+
@RestController
12+
public class HelloController {
13+
14+
@PostMapping("/parent")
15+
public void parentEndpoint(@RequestBody Superclass parent) {
16+
17+
}
18+
19+
}
20+
21+
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "@type")
22+
sealed class Superclass permits IntermediateClass {
23+
24+
public Superclass() {}
25+
}
26+
27+
@Schema(name = IntermediateClass.SCHEMA_NAME)
28+
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "@type")
29+
sealed class IntermediateClass extends Superclass permits FirstChildClass, SecondChildClass {
30+
31+
public static final String SCHEMA_NAME = "IntermediateClass";
32+
}
33+
34+
@Schema(name = FirstChildClass.SCHEMA_NAME)
35+
final class FirstChildClass extends IntermediateClass {
36+
37+
public static final String SCHEMA_NAME = "Image";
38+
}
39+
40+
@Schema(name = SecondChildClass.SCHEMA_NAME)
41+
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "@type")
42+
sealed class SecondChildClass extends IntermediateClass {
43+
44+
public static final String SCHEMA_NAME = "Mail";
45+
}
46+
47+
@Schema(name = ThirdChildClass.SCHEMA_NAME)
48+
final class ThirdChildClass extends SecondChildClass {
49+
50+
public static final String SCHEMA_NAME = "Home";
51+
}

0 commit comments

Comments
 (0)