Skip to content
Snippets Groups Projects
Commit 2409d721 authored by Shrikant Garg's avatar Shrikant Garg
Browse files

Merge branch 'springfox-upgrade' into 'master'

upgrade springfox version to 3.0.0

See merge request !201
parents c2ddf409 7f4135e2
No related branches found
No related tags found
1 merge request!201upgrade springfox version to 3.0.0
Pipeline #85729 failed
...@@ -16,7 +16,6 @@ ...@@ -16,7 +16,6 @@
<description>Legal service core</description> <description>Legal service core</description>
<properties> <properties>
<springfox-version>2.7.0</springfox-version>
</properties> </properties>
<dependencies> <dependencies>
...@@ -152,27 +151,6 @@ ...@@ -152,27 +151,6 @@
<version>1.2.0</version> <version>1.2.0</version>
<scope>test</scope> <scope>test</scope>
</dependency> </dependency>
<!-- swagger dependencies -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${springfox-version}</version>
<exclusions>
<exclusion>
<!--
Excluding com.google.guava:guava:jar:18.0, because it has security vulnerability
-->
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${springfox-version}</version>
</dependency>
</dependencies> </dependencies>
<build> <build>
......
package org.opengroup.osdu.legal.swagger;
import javax.servlet.http.HttpServletRequest;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import io.swagger.v3.oas.models.servers.Server;
import io.swagger.v3.oas.models.OpenAPI;
import springfox.documentation.oas.web.OpenApiTransformationContext;
import springfox.documentation.oas.web.WebMvcOpenApiTransformationFilter;
import springfox.documentation.spi.DocumentationType;
@Component
@Order(Ordered.LOWEST_PRECEDENCE)
public class SpringfoxSwaggerHostResolver implements WebMvcOpenApiTransformationFilter {
public boolean supports(DocumentationType delimiter) {
return delimiter == DocumentationType.OAS_30;
}
public OpenAPI transform(OpenApiTransformationContext<HttpServletRequest> context) {
OpenAPI swagger = context.getSpecification();
Server server = swagger.getServers().get(0);
if (server.getUrl().contains(":443")) {
// via the gateway
server.setUrl(server.getUrl().replace(":443", ""));
}
return swagger;
}
}
package org.opengroup.osdu.legal.swagger; package org.opengroup.osdu.legal.swagger;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org.opengroup.osdu.core.common.model.http.DpsHeaders; import org.opengroup.osdu.core.common.model.http.DpsHeaders;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ParameterBuilder; import org.springframework.context.annotation.Profile;
import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiKey; import springfox.documentation.service.ApiKey;
import springfox.documentation.service.AuthorizationScope; import springfox.documentation.service.AuthorizationScope;
import springfox.documentation.service.Parameter; import springfox.documentation.service.ParameterType;
import springfox.documentation.service.RequestParameter;
import springfox.documentation.service.SecurityReference; import springfox.documentation.service.SecurityReference;
import springfox.documentation.spi.DocumentationType; import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext; import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2; import springfox.documentation.builders.RequestParameterBuilder;
import springfox.documentation.oas.annotations.EnableOpenApi;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
@Configuration @Configuration
@EnableSwagger2 @EnableOpenApi
public class SwaggerDocumentationConfig { public class SwaggerDocumentationConfig {
public static final String AUTHORIZATION_HEADER = "Authorization"; public static final String AUTHORIZATION_HEADER = "Authorization";
public static final String DEFAULT_INCLUDE_PATTERN = "/.*"; public static final String DEFAULT_INCLUDE_PATTERN = "/.*";
@Bean @Bean
public Docket api() { public Docket api() {
ParameterBuilder builder = new ParameterBuilder(); RequestParameterBuilder builder = new RequestParameterBuilder();
List<Parameter> parameters = new ArrayList<>(); List<RequestParameter> parameters = new ArrayList<>();
builder.name(DpsHeaders.DATA_PARTITION_ID) builder.name(DpsHeaders.DATA_PARTITION_ID)
.description("tenant") .description("tenant")
.defaultValue("common") .in(ParameterType.HEADER)
.modelRef(new ModelRef("string"))
.parameterType("header")
.required(true) .required(true)
.build(); .build();
parameters.add(builder.build()); parameters.add(builder.build());
return new Docket(DocumentationType.SWAGGER_2) return new Docket(DocumentationType.OAS_30)
.globalOperationParameters(parameters) .globalRequestParameters(parameters)
.select() .select()
.apis(RequestHandlerSelectors.basePackage("org.opengroup.osdu.legal.api")) .apis(RequestHandlerSelectors.basePackage("org.opengroup.osdu.legal.api"))
.build() .build()
...@@ -48,13 +48,13 @@ public class SwaggerDocumentationConfig { ...@@ -48,13 +48,13 @@ public class SwaggerDocumentationConfig {
} }
private ApiKey apiKey() { private ApiKey apiKey() {
return new ApiKey("JWT", AUTHORIZATION_HEADER, "header"); return new ApiKey(AUTHORIZATION_HEADER, AUTHORIZATION_HEADER, "header");
} }
private SecurityContext securityContext() { private SecurityContext securityContext() {
return SecurityContext.builder() return SecurityContext.builder()
.securityReferences(defaultAuth()) .securityReferences(defaultAuth())
.forPaths(PathSelectors.regex(DEFAULT_INCLUDE_PATTERN)) .operationSelector(o -> PathSelectors.regex(DEFAULT_INCLUDE_PATTERN).test(o.requestMappingPattern()))
.build(); .build();
} }
...@@ -64,6 +64,6 @@ public class SwaggerDocumentationConfig { ...@@ -64,6 +64,6 @@ public class SwaggerDocumentationConfig {
AuthorizationScope[] authorizationScopes = AuthorizationScope[] authorizationScopes =
new AuthorizationScope[]{authorizationScope}; new AuthorizationScope[]{authorizationScope};
return Collections.singletonList( return Collections.singletonList(
new SecurityReference("JWT", authorizationScopes)); new SecurityReference(AUTHORIZATION_HEADER, authorizationScopes));
} }
} }
...@@ -11,6 +11,7 @@ ...@@ -11,6 +11,7 @@
<os-core-common.version>0.13.0-rc4</os-core-common.version> <os-core-common.version>0.13.0-rc4</os-core-common.version>
<snakeyaml.version>1.26</snakeyaml.version> <snakeyaml.version>1.26</snakeyaml.version>
<resilience4jVersion>1.7.0</resilience4jVersion> <resilience4jVersion>1.7.0</resilience4jVersion>
<springfox.version>3.0.0</springfox.version>
</properties> </properties>
<licenses> <licenses>
...@@ -92,6 +93,15 @@ ...@@ -92,6 +93,15 @@
</dependency> </dependency>
</dependencies> </dependencies>
</dependencyManagement> </dependencyManagement>
<dependencies>
<!--Swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>${springfox.version}</version>
</dependency>
</dependencies>
<profiles> <profiles>
<profile> <profile>
......
...@@ -42,12 +42,14 @@ public class AADSecurityConfig extends WebSecurityConfigurerAdapter { ...@@ -42,12 +42,14 @@ public class AADSecurityConfig extends WebSecurityConfigurerAdapter {
.authorizeRequests() .authorizeRequests()
.antMatchers("/", "/index.html", .antMatchers("/", "/index.html",
"/v2/api-docs", "/v2/api-docs",
"/v3/api-docs",
"/configuration/ui", "/configuration/ui",
"/swagger-resources/**", "/swagger-resources/**",
"/configuration/security", "/configuration/security",
"/swagger", "/swagger",
"/info", "/info",
"/swagger-ui.html", "/swagger-ui.html",
"/swagger-ui/**",
"/webjars/**").permitAll() "/webjars/**").permitAll()
.anyRequest().authenticated() .anyRequest().authenticated()
.and() .and()
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment