Skip to content

Commit

Permalink
code review
Browse files Browse the repository at this point in the history
  • Loading branch information
bnasslahsen committed Jan 2, 2025
1 parent e1fff95 commit 3114c10
Show file tree
Hide file tree
Showing 6 changed files with 192 additions and 43 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -110,35 +110,32 @@ else if (resolvedSchema.getProperties().containsKey(javaType.getRawClass().getSi
@Override
public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterator<ModelConverter> chain) {
JavaType javaType = springDocObjectMapper.jsonMapper().constructType(type.getType());

if (javaType == null || !chain.hasNext()) {
return null;
}

for (Field field : FieldUtils.getAllFields(javaType.getRawClass())) {
if (field.isAnnotationPresent(JsonUnwrapped.class)) {
PARENT_TYPES_TO_IGNORE.add(javaType.getRawClass().getSimpleName());
if (javaType != null) {
for (Field field : FieldUtils.getAllFields(javaType.getRawClass())) {
if (field.isAnnotationPresent(JsonUnwrapped.class)) {
PARENT_TYPES_TO_IGNORE.add(javaType.getRawClass().getSimpleName());
}
}
}

String parentName = type.getParent() == null ? null : type.getParent().getName();
if (parentName != null && PARENT_TYPES_TO_IGNORE.stream().noneMatch(parentName::startsWith)){
type.resolveAsRef(true);
}

Schema<?> resolvedSchema = getResolvedSchema(javaType, chain.next().resolve(type, context, chain));
if (resolvedSchema == null || resolvedSchema.get$ref() == null) {
return resolvedSchema;
}

if(resolvedSchema.get$ref().contains(Components.COMPONENTS_SCHEMAS_REF)) {
String schemaName = resolvedSchema.get$ref().substring(Components.COMPONENTS_SCHEMAS_REF.length());
Schema existingSchema = context.getDefinedModels().get(schemaName);
if (existingSchema != null && (existingSchema.getOneOf() != null || existingSchema.getAllOf() != null || existingSchema.getAnyOf() != null)) {
return resolvedSchema;
if (chain.hasNext()) {
if (!type.isResolveAsRef() && type.getParent() != null
&& PARENT_TYPES_TO_IGNORE.stream().noneMatch(ignore -> type.getParent().getName().startsWith(ignore)))
type.resolveAsRef(true);
Schema<?> resolvedSchema = chain.next().resolve(type, context, chain);
resolvedSchema = getResolvedSchema(javaType, resolvedSchema);
if (resolvedSchema == null || resolvedSchema.get$ref() == null) {
return resolvedSchema;
}
if(resolvedSchema.get$ref().contains(Components.COMPONENTS_SCHEMAS_REF)) {
String schemaName = resolvedSchema.get$ref().substring(Components.COMPONENTS_SCHEMAS_REF.length());
Schema existingSchema = context.getDefinedModels().get(schemaName);
if (existingSchema != null && (existingSchema.getOneOf() != null || existingSchema.getAllOf() != null)) {
return resolvedSchema;
}
}
return composePolymorphicSchema(type, resolvedSchema, context.getDefinedModels().values());
}
}
return composePolymorphicSchema(type, resolvedSchema, context.getDefinedModels().values());
return null;
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,27 +23,22 @@ import org.springdoc.core.properties.SpringDocConfigProperties.ApiDocs.OpenApiVe
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.ComponentScan
import org.springframework.context.annotation.Configuration
import test.org.springdoc.api.AbstractKotlinSpringDocMVCTest


@SpringBootTest//(classes = [Config::class])
class SpringDocApp13Test : AbstractKotlinSpringDocMVCTest() {


@Configuration
class Config{
@Bean
fun springDocConfigProperties():SpringDocConfigProperties{
val x= SpringDocConfigProperties()
x.apiDocs.version = OpenApiVersion.OPENAPI_3_1
return x
}

}


@SpringBootApplication
class DemoApplication
@SpringBootApplication
class DemoApplication {
@Bean
fun springDocConfigProperties():SpringDocConfigProperties{
val x= SpringDocConfigProperties()
x.apiDocs.version = OpenApiVersion.OPENAPI_3_1
return x
}
}


}
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
package test.org.springdoc.api.app13


import io.swagger.v3.oas.annotations.OpenAPI31
import io.swagger.v3.oas.annotations.media.Schema
import org.springframework.web.bind.annotation.PostMapping
import org.springframework.web.bind.annotation.RequestBody
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/*
*
* * Copyright 2019-2020 the original author or authors.
* *
* * Licensed under the Apache License, Version 2.0 (the "License");
* * you may not use this file except in compliance with the License.
* * You may obtain a copy of the License at
* *
* * https://www.apache.org/licenses/LICENSE-2.0
* *
* * Unless required by applicable law or agreed to in writing, software
* * distributed under the License is distributed on an "AS IS" BASIS,
* * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* * See the License for the specific language governing permissions and
* * limitations under the License.
*
*/

package test.org.springdoc.api.app14

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.context.annotation.ComponentScan
import test.org.springdoc.api.AbstractKotlinSpringDocMVCTest

class SpringDocApp14Test : AbstractKotlinSpringDocMVCTest() {

@SpringBootApplication
class DemoApplication

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
/*
*
* * Copyright 2019-2020 the original author or authors.
* *
* * Licensed under the Apache License, Version 2.0 (the "License");
* * you may not use this file except in compliance with the License.
* * You may obtain a copy of the License at
* *
* * https://www.apache.org/licenses/LICENSE-2.0
* *
* * Unless required by applicable law or agreed to in writing, software
* * distributed under the License is distributed on an "AS IS" BASIS,
* * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* * See the License for the specific language governing permissions and
* * limitations under the License.
*
*/

package test.org.springdoc.api.app14

import io.swagger.v3.oas.annotations.media.Schema
import org.springframework.web.bind.annotation.PostMapping
import org.springframework.web.bind.annotation.RequestBody
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RestController

@Schema(description = "Generic description")
data class KeyValue(
val key: String,
val value: String,
)

@Schema
data class SomeDTO(
@Schema(description = "Description A", allOf = [KeyValue::class]) val field_a: KeyValue,
@Schema(description = "Description B", allOf = [KeyValue::class]) val field_b: KeyValue,
)

@RestController
@RequestMapping("/test")
class TestController {

@PostMapping("/test")
fun create(@RequestBody some: SomeDTO) {

}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
{
"openapi": "3.0.1",
"info": {
"title": "OpenAPI definition",
"version": "v0"
},
"servers": [
{
"url": "http://localhost",
"description": "Generated server url"
}
],
"paths": {
"/test/test": {
"post": {
"tags": [
"test-controller"
],
"operationId": "create",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SomeDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"KeyValue": {
"required": [
"key",
"value"
],
"type": "object",
"description": "Generic description",
"allOf": [
{
"$ref": "#/components/schemas/KeyValue"
},
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
]
},
"SomeDTO": {
"required": [
"field_a",
"field_b"
],
"type": "object",
"properties": {
"field_a": {
"$ref": "#/components/schemas/KeyValue"
},
"field_b": {
"$ref": "#/components/schemas/KeyValue"
}
}
}
}
}
}

0 comments on commit 3114c10

Please sign in to comment.