Merge branch 'vazha/refactorSwaggerToUseConfigurationProperty' into 'master'

Refactor Swagger Configuration to use '@ConfigurationProperties' from '@Value'

See merge request !529

legal-core/src/main/java/org/opengroup/osdu/legal/swagger/SwaggerConfiguration.java

@@ -14,7 +14,7 @@ import io.swagger.v3.oas.models.servers.Server;
 import io.swagger.v3.oas.models.tags.Tag;
 import org.opengroup.osdu.core.common.model.http.DpsHeaders;
 import org.springdoc.core.customizers.OperationCustomizer;
-import org.springframework.beans.factory.annotation.Value;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Profile;
@@ -27,32 +27,8 @@ import java.util.List;
 @Profile("!noswagger")
 public class SwaggerConfiguration {
 
-    @Value("${api.title}")
-    private String apiTitle;
-
-    @Value("${api.description}")
-    private String apiDescription;
-
-    @Value("${api.version}")
-    private String apiVersion;
-
-    @Value("${api.contact.name}")
-    private String contactName;
-
-    @Value("${api.contact.email}")
-    private String contactEmail;
-
-    @Value("${api.license.name}")
-    private String licenseName;
-
-    @Value("${api.license.url}")
-    private String licenseUrl;
-
-    @Value("${api.server.url}")
-    private String apiServerUrl;
-
-    @Value("${api.server.fullUrl.enabled:false}")
-    private boolean isServerFullUrlEnabled;
+    @Autowired
+    private SwaggerConfigurationProperties swaggerConfigurationProperties;
 
     @Bean
     public OpenAPI customOpenAPI() {
@@ -73,10 +49,10 @@ public class SwaggerConfiguration {
                 .info(apiInfo())
                 .tags(tags());
 
-        if(isServerFullUrlEnabled)
+        if(swaggerConfigurationProperties.isApiServerFullUrlEnabled())
             return openAPI;
         return openAPI
-                .servers(Arrays.asList(new Server().url(apiServerUrl)));
+                .servers(Arrays.asList(new Server().url(swaggerConfigurationProperties.getApiServerUrl())));
     }
 
     private List<Tag> tags() {
@@ -90,11 +66,11 @@ public class SwaggerConfiguration {
 
     private Info apiInfo() {
         return new Info()
-                .title(apiTitle)
-                .description(apiDescription)
-                .version(apiVersion)
-                .license(new License().name(licenseName).url(licenseUrl))
-                .contact(new Contact().name(contactName).email(contactEmail));
+                .title(swaggerConfigurationProperties.getApiTitle())
+                .description(swaggerConfigurationProperties.getApiDescription())
+                .version(swaggerConfigurationProperties.getApiVersion())
+                .license(new License().name(swaggerConfigurationProperties.getApiLicenseName()).url(swaggerConfigurationProperties.getApiLicenseUrl()))
+                .contact(new Contact().name(swaggerConfigurationProperties.getApiContactName()).email(swaggerConfigurationProperties.getApiContactEmail()));
     }
 
     @Bean

legal-core/src/main/java/org/opengroup/osdu/legal/swagger/SwaggerConfigurationProperties.java

+package org.opengroup.osdu.legal.swagger;
+
+
+import lombok.Getter;
+import lombok.Setter;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.stereotype.Component;
+
+@Getter
+@Setter
+@Component
+@ConfigurationProperties(prefix = "swagger")
+public class SwaggerConfigurationProperties {
+
+    private String apiTitle;
+    private String apiDescription;
+    private String apiVersion;
+    private String apiContactName;
+    private String apiContactEmail;
+    private String apiLicenseName;
+    private String apiLicenseUrl;
+    private String apiServerUrl;
+    private boolean apiServerFullUrlEnabled;
+
+}
\ No newline at end of file

legal-core/src/main/resources/swagger.properties

@@ -9,14 +9,15 @@ springdoc.swagger-ui.displayOperationId=true
 springdoc.api-docs.path=/api-docs
 
 #OpenAPI 3.0 - Legal properties
-api.title=Legal Service
-api.description=Legal Service provides APIs to help with legal data governance in the Data Lake.
-api.version=1.0.0
-api.contact.name=OSDU Data Platform Team
-api.contact.email=dps@OSDU.org
-api.license.name=Apache 2.0
-api.license.url=https://www.apache.org/licenses/LICENSE-2.0.html
-api.server.url=${server.servlet.contextPath}
+swagger.apiTitle=Legal Service
+swagger.apiDescription=Legal Service provides APIs to help with legal data governance in the Data Lake.
+swagger.apiVersion=1.0.0
+swagger.apiContactName=OSDU Data Platform Team
+swagger.apiContactEmail=dps@OSDU.org
+swagger.apiLicenseName=Apache 2.0
+swagger.apiLicenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
+swagger.apiServerUrl=${server.servlet.contextPath:/}
+swagger.apiServerFullUrlEnabled=${api.server.fullUrl.enabled:false}
 
 #LegalTag API related properties
 legalTagApi.createLegalTag.summary=Creates the LegalTag for the given `name`.