MaDgIK
/
uoa-admin-tools
13
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Admin Tools | log4j2]: SwaggerConfig.java: Updated swagger to separate libraries to folders.

This commit is contained in:
Konstantina Galouni 2022-10-20 10:27:53 +03:00
parent 031192b9fb
commit 708e59f1e1
1 changed files with 108 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

194
src/main/java/eu/dnetlib/uoaadmintools/configuration/SwaggerConfig.java
View File

@ -1,86 +1,108 @@
package eu.dnetlib.uoaadmintools.configuration; package eu.dnetlib.uoaadmintools.configuration;
import eu.dnetlib.uoaadmintools.configuration.properties.APIProperties; import eu.dnetlib.uoaadmintools.configuration.properties.APIProperties;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
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 org.springframework.context.annotation.Profile; import org.springframework.context.annotation.Profile;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry; import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter; import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder; import springfox.documentation.builders.ParameterBuilder;
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.schema.ModelRef;
import springfox.documentation.service.ApiInfo; import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter; import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType; import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2; import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.Collections; import java.util.Collections;
import java.util.List; import java.util.List;
/** /**
* Swagger configuration class * Swagger configuration class
*/ */
@Configuration @Configuration
@Profile({"swagger"}) @Profile({"swagger"})
@EnableSwagger2 @EnableSwagger2
public class SwaggerConfig extends WebMvcConfigurerAdapter { public class SwaggerConfig extends WebMvcConfigurerAdapter {
private final APIProperties apiProperties; private final APIProperties apiProperties;
@Autowired @Autowired
public SwaggerConfig(APIProperties apiProperties) { public SwaggerConfig(APIProperties apiProperties) {
this.apiProperties = apiProperties; this.apiProperties = apiProperties;
} }
@Bean
@Bean public Docket createRestApi() {
public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2)
return new Docket(DocumentationType.SWAGGER_2) // .globalOperationParameters(globalParameterList())
// .globalOperationParameters(globalParameterList()) .apiInfo(apiInfo())
.apiInfo(apiInfo()) .select()
.select() .apis(RequestHandlerSelectors.basePackage("eu.dnetlib.uoaadmintools.controllers"))
.apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any())
.paths(PathSelectors.any()) .build();
.build(); }
}
@Bean
private ApiInfo apiInfo() { public Docket createRestApiLibrary() {
return new ApiInfoBuilder() return new Docket(DocumentationType.SWAGGER_2)
.title(this.apiProperties.getTitle()) // .globalOperationParameters(globalParameterList())
.description(this.apiProperties.getDescription()) .apiInfo(apiInfo())
.version(this.apiProperties.getVersion()) .groupName("Library")
.build(); .select()
} .apis(RequestHandlerSelectors.basePackage("eu.dnetlib.uoaadmintoolslibrary.controllers"))
.paths(PathSelectors.any())
private List<Parameter> globalParameterList() { .build();
Parameter authTokenHeader = new ParameterBuilder() }
.name("Session") // name of the header
.modelRef(new ModelRef("string")) // data-type of the header @Bean
.required(false) public Docket createRestApiAuthorizationLibrary() {
.parameterType("header") return new Docket(DocumentationType.SWAGGER_2)
.description("Session ID") .apiInfo(apiInfo())
.build(); .groupName("Authorization Library")
return Collections.singletonList(authTokenHeader); .select()
} .apis(RequestHandlerSelectors.basePackage("eu.dnetlib.uoaauthorizationlibrary.controllers"))
.paths(PathSelectors.any())
@Override .build();
public void addViewControllers(ViewControllerRegistry registry) { }
registry.addRedirectViewController("/v2/api-docs", "/v2/api-docs");
registry.addRedirectViewController("/swagger-resources/configuration/ui", "/swagger-resources/configuration/ui"); private ApiInfo apiInfo() {
registry.addRedirectViewController("/swagger-resources/configuration/security", "/swagger-resources/configuration/security"); return new ApiInfoBuilder()
registry.addRedirectViewController("/swagger-resources", "/swagger-resources"); .title(this.apiProperties.getTitle())
} .description(this.apiProperties.getDescription())
.version(this.apiProperties.getVersion())
@Override .build();
public void addResourceHandlers(ResourceHandlerRegistry registry) { }
registry.addResourceHandler("/swagger-ui.html**").addResourceLocations("classpath:/META-INF/resources/swagger-ui.html");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/"); private List<Parameter> globalParameterList() {
} Parameter authTokenHeader = new ParameterBuilder()
.name("Session") // name of the header
} .modelRef(new ModelRef("string")) // data-type of the header
.required(false)
.parameterType("header")
.description("Session ID")
.build();
return Collections.singletonList(authTokenHeader);
}
@Override
public void addViewControllers(ViewControllerRegistry registry) {
registry.addRedirectViewController("/v2/api-docs", "/v2/api-docs");
registry.addRedirectViewController("/swagger-resources/configuration/ui", "/swagger-resources/configuration/ui");
registry.addRedirectViewController("/swagger-resources/configuration/security", "/swagger-resources/configuration/security");
registry.addRedirectViewController("/swagger-resources", "/swagger-resources");
}
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/swagger-ui.html**").addResourceLocations("classpath:/META-INF/resources/swagger-ui.html");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}