Upgrade swagger from version 2 to 3; (#496)

Alter related dependency libs and configurations;
Disable default swagger page with sample data;

Author: olivershen-wow

center/build.gradle

@@ -52,9 +52,8 @@ dependencies {
 
     compile group: 'org.springframework.security', name: 'spring-security-oauth2-client', version: '5.2.2.RELEASE'
 
-    compile('io.springfox:springfox-swagger2:3.0.0')
-    compile('io.springfox:springfox-swagger-ui:3.0.0')
-    compile('io.springfox:springfox-boot-starter:3.0.0')
+    compile('org.springdoc:springdoc-openapi-core:1.1.49')
+    compile('org.springdoc:springdoc-openapi-ui:1.4.1')
 
     compile group: 'org.jsoup', name: 'jsoup', version: '1.10.1'
     compile group: 'org.yaml', name: 'snakeyaml', version: '1.25'

center/src/main/java/com/microsoft/hydralab/center/config/SwaggerConfig.java

@@ -3,47 +3,19 @@
 
 package com.microsoft.hydralab.center.config;
 
-import org.springframework.beans.factory.annotation.Value;
-import org.springframework.context.annotation.Bean;
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.info.Contact;
+import io.swagger.v3.oas.annotations.info.Info;
 import org.springframework.context.annotation.Configuration;
-import springfox.documentation.builders.ApiInfoBuilder;
-import springfox.documentation.builders.PathSelectors;
-import springfox.documentation.builders.RequestHandlerSelectors;
-import springfox.documentation.service.ApiInfo;
-import springfox.documentation.service.Contact;
-import springfox.documentation.spi.DocumentationType;
-import springfox.documentation.spring.web.plugins.Docket;
-import springfox.documentation.swagger2.annotations.EnableSwagger2;
-
-import java.net.InetAddress;
-import java.net.UnknownHostException;
 
 /**
  * Created by bsp on 17/12/16.
  */
 @Configuration
-@EnableSwagger2
-//@Profile({"dev", "test"})
+@OpenAPIDefinition(info =
+@Info(title = "Hydra Lab API", version = "1.0.0", description = "Hydra Lab", contact =
+@Contact(name = "Microsoft Hydra Lab Support", email = "hydra_lab_support@microsoft.com")
+)
+)
 public class SwaggerConfig {
-    @Value("${server.port}")
-    private String port;
-
-    @Bean
-    public Docket docket() throws UnknownHostException {
-        ApiInfo apiInfo = new ApiInfoBuilder()
-                .title("Hydra Lab API")
-                .description("Hydra Lab")
-                .termsOfServiceUrl("")
-                .contact(new Contact("Microsoft Hydra Lab Support ", "", "hydra_lab_support@microsoft.com"))
-                .version("3.0.0")
-                .build();
-
-        return new Docket(DocumentationType.SWAGGER_2)
-                .apiInfo(apiInfo)
-                .host(String.format("%s:%s", InetAddress.getLocalHost().getHostName(), port))
-                .select()
-                .apis(RequestHandlerSelectors.basePackage("com.microsoft.hydralab.center.controller"))
-                .paths(PathSelectors.any())
-                .build();
-    }
 }

center/src/main/java/com/microsoft/hydralab/center/config/WebMvcConfiguration.java

@@ -7,12 +7,15 @@
 import com.microsoft.hydralab.center.interceptor.BaseInterceptor;
 import com.microsoft.hydralab.center.interceptor.CorsInterceptor;
 import com.microsoft.hydralab.common.util.Const;
+import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.http.converter.HttpMessageConverter;
+import org.springframework.http.converter.StringHttpMessageConverter;
 import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
 import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
 import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+import org.springframework.web.servlet.view.InternalResourceViewResolver;
 
 import javax.annotation.Resource;
 import java.util.List;
@@ -55,6 +58,14 @@ public void addResourceHandlers(ResourceHandlerRegistry registry) {
 
     @Override
     public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
+        // Sequence should be kept, currently this converter is only used for /v3/api-docs endpoint to avoid malformed content which should be in json format
+        converters.add(new StringHttpMessageConverter());
         converters.add(fastJsonHttpMessageConverter);
     }
+
+    @Bean
+    public InternalResourceViewResolver defaultViewResolver() {
+        // Add this to make sure redirect can be made when /swagger-ui.html would redirect to swagger-ui/index.html using the configUrl in /v3/api-docs
+        return new InternalResourceViewResolver();
+    }
 }

center/src/main/resources/application.yml

@@ -46,6 +46,10 @@ logging:
   level:
     org.hibernate.SQL: INFO
 
+springdoc:
+  swagger-ui:
+    disable-swagger-default-url: true
+
 app:
   batteryStrategy: ${BATTERY_STRATEGY:Economic}
   access-token-limit: 2