Skip to content

Replace nested Page with PagedModel when serialization mode is VIA_DTO #3335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jjh75607 wants to merge 1 commit into
base: main
Choose a base branch
from
+262 −8
Open

Replace nested Page with PagedModel when serialization mode is VIA_DTO #3335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 18 additions & 8 deletions ...napi-starter-common/src/main/java/org/springdoc/core/converters/PageOpenAPIConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@
import org.springframework.core.ResolvableType;
import org.springframework.data.web.PagedModel;

import static org.springdoc.core.utils.SpringDocUtils.getParentTypeName;

/**
* The Spring Data Page type model converter.
*
Expand Down Expand Up @@ -119,7 +117,7 @@ public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterato
if (!type.isSchemaProperty())
type = resolvePagedModelType(javaType, type);
else
type.name(getParentTypeName(type, cls));
type.type(pagedModelType(javaType)).resolveAsRef(true);
}
}
Schema schema = (chain.hasNext()) ? chain.next().resolve(type, context, chain) : null;
Expand All @@ -137,11 +135,7 @@ public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterato
*/
private AnnotatedType resolvePagedModelType(JavaType type, AnnotatedType originalType) {
if (type.hasGenericTypes()) {
JavaType innerType = type.containedType(0);
Type pagedModelType = ResolvableType
.forClassWithGenerics(PagedModel.class, ResolvableType.forType(innerType))
.getType();
return new AnnotatedType(pagedModelType)
return new AnnotatedType(pagedModelType(type))
.resolveAsRef(true)
.ctxAnnotations(originalType.getCtxAnnotations());
}
Expand All @@ -150,6 +144,22 @@ private AnnotatedType resolvePagedModelType(JavaType type, AnnotatedType origina
}
}

/**
* The PagedModel type matching the given Page type.
*
* @param type the page type
* @return the paged model type
*/
private Type pagedModelType(JavaType type) {
if (type.hasGenericTypes()) {
JavaType innerType = type.containedType(0);
return ResolvableType
.forClassWithGenerics(PagedModel.class, ResolvableType.forType(innerType))
.getType();
}
return PagedModel.class;
}

/**
* Sort page schema properties.
*
Expand Down
10 changes: 10 additions & 0 deletions ...openapi-hateoas-tests/src/test/java/test/org/springdoc/api/v30/app10/HelloController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,16 @@ public PagedModel pagedModelRaw() {
return pagedModelSimple();
}

@GetMapping("/dummy-page-simple")
public Dummy<Page<String>> dummyPageSimple() {
return new Dummy<>(pageSimple());
}

@GetMapping("/dummy-page-complex")
public Dummy<Page<Dummy<List<String>>>> dummyPageComplex() {
return new Dummy<>(pageComplex());
}

private <T> PagedModel<T> pagedModel(T value) {
return new PagedModel<>(pageImpl(value));
}
Expand Down
10 changes: 10 additions & 0 deletions ...openapi-hateoas-tests/src/test/java/test/org/springdoc/api/v31/app10/HelloController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,16 @@ public PagedModel pagedModelRaw() {
return pagedModelSimple();
}

@GetMapping("/dummy-page-simple")
public Dummy<Page<String>> dummyPageSimple() {
return new Dummy<>(pageSimple());
}

@GetMapping("/dummy-page-complex")
public Dummy<Page<Dummy<List<String>>>> dummyPageComplex() {
return new Dummy<>(pageComplex());
}

private <T> PagedModel<T> pagedModel(T value) {
return new PagedModel<>(pageImpl(value));
}
Expand Down
56 changes: 56 additions & 0 deletions ...-tests/springdoc-openapi-hateoas-tests/src/test/resources/results/3.0.1/app10-direct.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,46 @@
}
}
}
},
"/dummy-page-simple": {
"get": {
"tags": [
"hello-controller"
],
"operationId": "dummyPageSimple",
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DummyPageString"
}
}
}
}
}
}
},
"/dummy-page-complex": {
"get": {
"tags": [
"hello-controller"
],
"operationId": "dummyPageComplex",
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DummyPageDummyListString"
}
}
}
}
}
}
}
},
"components": {
Expand Down Expand Up @@ -462,6 +502,22 @@
"type": "boolean"
}
}
},
"DummyPageString": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/PageString"
}
}
},
"DummyPageDummyListString": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/PageDummyListString"
}
}
}
}
}
Expand Down
56 changes: 56 additions & 0 deletions ...tests/springdoc-openapi-hateoas-tests/src/test/resources/results/3.0.1/app10-via_dto.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,46 @@
}
}
}
},
"/dummy-page-simple": {
"get": {
"tags": [
"hello-controller"
],
"operationId": "dummyPageSimple",
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DummyPageString"
}
}
}
}
}
}
},
"/dummy-page-complex": {
"get": {
"tags": [
"hello-controller"
],
"operationId": "dummyPageComplex",
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DummyPageDummyListString"
}
}
}
}
}
}
}
},
"components": {
Expand Down Expand Up @@ -252,6 +292,22 @@
"type": "string"
}
}
},
"DummyPageString": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/PagedModelString"
}
}
},
"DummyPageDummyListString": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/PagedModelDummyListString"
}
}
}
}
}
Expand Down
56 changes: 56 additions & 0 deletions ...-tests/springdoc-openapi-hateoas-tests/src/test/resources/results/3.1.0/app10-direct.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,46 @@
}
}
}
},
"/dummy-page-simple": {
"get": {
"tags": [
"hello-controller"
],
"operationId": "dummyPageSimple",
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DummyPageString"
}
}
}
}
}
}
},
"/dummy-page-complex": {
"get": {
"tags": [
"hello-controller"
],
"operationId": "dummyPageComplex",
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DummyPageDummyListString"
}
}
}
}
}
}
}
},
"components": {
Expand Down Expand Up @@ -381,6 +421,22 @@
"type": "boolean"
}
}
},
"DummyPageString": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/PageString"
}
}
},
"DummyPageDummyListString": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/PageDummyListString"
}
}
}
}
}
Expand Down
56 changes: 56 additions & 0 deletions ...tests/springdoc-openapi-hateoas-tests/src/test/resources/results/3.1.0/app10-via_dto.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,46 @@
}
}
}
},
"/dummy-page-simple": {
"get": {
"tags": [
"hello-controller"
],
"operationId": "dummyPageSimple",
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DummyPageString"
}
}
}
}
}
}
},
"/dummy-page-complex": {
"get": {
"tags": [
"hello-controller"
],
"operationId": "dummyPageComplex",
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DummyPageDummyListString"
}
}
}
}
}
}
}
},
"components": {
Expand Down Expand Up @@ -205,6 +245,22 @@
"$ref": "#/components/schemas/PageMetadata"
}
}
},
"DummyPageString": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/PagedModelString"
}
}
},
"DummyPageDummyListString": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/PagedModelDummyListString"
}
}
}
}
}
Expand Down