Merge branch 'tdevilleduc-feature/schema-property-resolver'

bnasslahsen · bnasslahsen · commit b4dd675aef6c · 2020-03-20T22:31:23.000+01:00
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/Constants.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/Constants.java
@@ -38,6 +38,8 @@ public final class Constants {
 
 	public static final String SPRINGDOC_ENABLED = "springdoc.api-docs.enabled";
 
+	public static final String SPRINGDOC_SCHEMA_RESOLVE_PROPERTIES = "springdoc.api-docs.resolve-schema-properties";
+
 	public static final String SPRINGDOC_CACHE_DISABLED = "springdoc.cache.disabled";
 
 	public static final String SPRINGDOC_SWAGGER_UI_ENABLED = "springdoc.swagger-ui.enabled";
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/OpenAPIBuilder.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/OpenAPIBuilder.java
@@ -44,6 +44,7 @@
 import io.swagger.v3.oas.models.info.Contact;
 import io.swagger.v3.oas.models.info.Info;
 import io.swagger.v3.oas.models.info.License;
+import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.security.SecurityScheme;
 import io.swagger.v3.oas.models.servers.Server;
 import org.apache.commons.lang3.StringUtils;
@@ -226,8 +227,21 @@ public Operation buildTags(HandlerMethod handlerMethod, Operation operation, Ope
 		return operation;
 	}
 
-	private boolean isAutoTagClasses(Operation operation) {
-		return CollectionUtils.isEmpty(operation.getTags()) && springDocConfigProperties.isAutoTagClasses();
+	public Schema resolveProperties(Schema schema, PropertyResolverUtils propertyResolverUtils) {
+		resolveProperty(schema::getName, schema::name, propertyResolverUtils);
+		resolveProperty(schema::getTitle, schema::title, propertyResolverUtils);
+		resolveProperty(schema::getDescription, schema::description, propertyResolverUtils);
+
+		Map<String, Schema> properties = schema.getProperties();
+		if (!CollectionUtils.isEmpty(properties)) {
+			Map<String, Schema> resolvedSchemas = properties.entrySet().stream().map(es -> {
+				es.setValue(resolveProperties(es.getValue(), propertyResolverUtils));
+				return es;
+			}).collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
+			schema.setProperties(resolvedSchemas);
+		}
+
+		return schema;
 	}
 
 	public void setServerBaseUrl(String serverBaseUrl) {
@@ -376,6 +390,10 @@ private OpenAPIDefinition getApiDefClass(ClassPathScanningCandidateComponentProv
 		return null;
 	}
 
+	private boolean isAutoTagClasses(Operation operation) {
+		return CollectionUtils.isEmpty(operation.getTags()) && springDocConfigProperties.isAutoTagClasses();
+	}
+
 	private Set<io.swagger.v3.oas.annotations.security.SecurityScheme> getSecuritySchemesClasses(
 			ClassPathScanningCandidateComponentProvider scanner, List<String> packagesToScan) {
 		Set<io.swagger.v3.oas.annotations.security.SecurityScheme> apiSecurityScheme = new HashSet<>();
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/PropertyResolverUtils.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/PropertyResolverUtils.java
@@ -28,7 +28,7 @@ public PropertyResolverUtils(ConfigurableBeanFactory factory) {
 		this.factory = factory;
 	}
 
-	String resolve(String parameterProperty) {
+	public String resolve(String parameterProperty) {
 		return factory.resolveEmbeddedValue(parameterProperty);
 	}
 }
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java
@@ -151,6 +151,8 @@ public static class ApiDocs {
 		 */
 		private boolean enabled = true;
 
+		private boolean resolveSchemaProperties;
+
 		private Groups groups = new Groups();
 
 		public String getPath() {
@@ -176,6 +178,14 @@ public Groups getGroups() {
 		public void setGroups(Groups groups) {
 			this.groups = groups;
 		}
+
+		public boolean isResolveSchemaProperties() {
+			return resolveSchemaProperties;
+		}
+
+		public void setResolveSchemaProperties(boolean resolveSchemaProperties) {
+			this.resolveSchemaProperties = resolveSchemaProperties;
+		}
 	}
 
 	public static class Groups {
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfiguration.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfiguration.java
@@ -20,17 +20,21 @@
 
 import java.util.Collections;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import io.swagger.v3.core.converter.ModelConverter;
+import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.media.ObjectSchema;
+import io.swagger.v3.oas.models.media.Schema;
 import org.springdoc.core.converters.AdditionalModelsConverter;
 import org.springdoc.core.converters.ModelConverterRegistrar;
 import org.springdoc.core.converters.PropertyCustomizingConverter;
 import org.springdoc.core.converters.ResponseSupportConverter;
 import org.springdoc.core.customizers.OpenApiBuilderCustomiser;
+import org.springdoc.core.customizers.OpenApiCustomiser;
 import org.springdoc.core.customizers.PropertyCustomizer;
 
 import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
@@ -47,6 +51,7 @@
 
 import static org.springdoc.core.Constants.SPRINGDOC_CACHE_DISABLED;
 import static org.springdoc.core.Constants.SPRINGDOC_ENABLED;
+import static org.springdoc.core.Constants.SPRINGDOC_SCHEMA_RESOLVE_PROPERTIES;
 import static org.springdoc.core.SpringDocUtils.getConfig;
 
 @Configuration
@@ -124,6 +129,16 @@ public GenericParameterBuilder parameterBuilder(PropertyResolverUtils propertyRe
 		return new GenericParameterBuilder(propertyResolverUtils);
 	}
 
+	@Bean
+	@ConditionalOnProperty(SPRINGDOC_SCHEMA_RESOLVE_PROPERTIES)
+	public OpenApiCustomiser propertiesResolverForSchema(PropertyResolverUtils propertyResolverUtils, OpenAPIBuilder openAPIBuilder) {
+		return openApi -> {
+			Components components = openApi.getComponents();
+			Map<String, Schema> schemas = components.getSchemas();
+			schemas.values().forEach(schema -> openAPIBuilder.resolveProperties(schema, propertyResolverUtils));
+		};
+	}
+
 	static class ConditionOnCacheOrGroupedOpenApi extends AnyNestedCondition {
 
 		ConditionOnCacheOrGroupedOpenApi() {
diff --git a/springdoc-openapi-data-rest/pom.xml b/springdoc-openapi-data-rest/pom.xml
@@ -29,6 +29,11 @@
 			<artifactId>querydsl-core</artifactId>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>jakarta.annotation</groupId>
+			<artifactId>jakarta.annotation-api</artifactId>
+			<optional>true</optional>
+		</dependency>
 		<dependency>
 			<groupId>org.springdoc</groupId>
 			<artifactId>springdoc-openapi-webmvc-core</artifactId>
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app101/HelloController.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app101/HelloController.java
@@ -0,0 +1,22 @@
+package test.org.springdoc.api.app101;
+
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/hello")
+public class HelloController {
+
+	@GetMapping
+	@ApiResponse(content = @Content(schema = @Schema(
+		description = "${test.app101.operation.hello.response.schema.description}",
+		implementation = HelloDTO.class)))
+	public HelloDTO hello() {
+		return new HelloDTO();
+	}
+
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app101/HelloDTO.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app101/HelloDTO.java
@@ -0,0 +1,21 @@
+package test.org.springdoc.api.app101;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
+
+@Schema(description = "${test.app101.schema.hello.description}")
+public class HelloDTO {
+
+    @Schema(description = "${test.app101.schema.hello.param.id.description}")
+    private String id;
+
+    @JsonProperty("id")
+    public String getId() {
+        return id;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app101/SpringDocApp101Test.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app101/SpringDocApp101Test.java
@@ -0,0 +1,32 @@
+/*
+ *
+ *  * 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.app101;
+
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.ActiveProfiles;
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+@ActiveProfiles("101")
+public class SpringDocApp101Test extends AbstractSpringDocTest {
+
+    @SpringBootApplication
+    static class SpringDocTestApp {}
+
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/application-101.yml b/springdoc-openapi-webmvc-core/src/test/resources/application-101.yml
@@ -0,0 +1,16 @@
+test:
+  app101:
+    operation:
+      hello:
+        response:
+          schema:
+            description: Description of schema of api response hello
+    schema:
+      hello:
+        description: Description of schema of hello entity
+        param:
+          id:
+            description: Description of schema of param id for api hello
+springdoc:
+  api-docs:
+    resolve-schema-properties: true
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/app101.json b/springdoc-openapi-webmvc-core/src/test/resources/results/app101.json
@@ -0,0 +1,49 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/hello": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "hello",
+        "responses": {
+          "default": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/HelloDTO"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "HelloDTO": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Description of schema of param id for api hello"
+          }
+        },
+        "description": "Description of schema of hello entity"
+      }
+    }
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public PropertyResolverUtils(ConfigurableBeanFactory factory) {`
`28`	`28`	`this.factory = factory;`
`29`	`29`	`}`
`30`	`30`
`31`		`- String resolve(String parameterProperty) {`
	`31`	`+ public String resolve(String parameterProperty) {`
`32`	`32`	`return factory.resolveEmbeddedValue(parameterProperty);`
`33`	`33`	`}`
`34`	`34`	`}`