新手上路-搭建項(xiàng)目-springboot-swagger2

XGBCCC 發(fā)布于2019-08-14 18:38 / 3517人閱讀

摘要：新手上路搭建項(xiàng)目是一個(gè)接口文檔軟件界面如下添加這里使用版本可以正常使用配置文件測試新手上路。

新手上路-搭建項(xiàng)目-springboot-swagger2

swagger2 是一個(gè)接口文檔軟件

界面如下

gradle添加

compile("io.springfox:springfox-swagger2:$swagger2Version")
compile("io.springfox:springfox-swagger-ui:$swaggerUi")

這里使用2.4.0版本可以正常使用

swagger2配置文件

import org.springframework.context.annotation.Bean;
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;

@EnableSwagger2
@Configuration
public class Swagger2Config {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.seal_de.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger2測試")
                .description("新手上路-swagger2。https://git.oschina.net/sealde/springboot-javaconfig/tree/dev2")
                .termsOfServiceUrl("https://git.oschina.net/sealde/springboot-javaconfig/tree/dev2")
                .version("0.0.1")
                .contact(new Contact("seal_de", "https://git.oschina.net/sealde", "seal.de@foxmail.com"))
                .build();
    }
}

配置資源處理器

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
    ...
    
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
    
    ...
}

注意事項(xiàng)

如果有配置token驗(yàn)證等機(jī)制，建議將swagger2的一些請求放行

下面只是一個(gè)例子，看實(shí)際情況進(jìn)行配置

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
    ...

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
       registry.addInterceptor(new TokenInterceptor(tokenManager))
               .addPathPatterns("/**").excludePathPatterns("/configuration/ui", "/configuration/security", "/v2/api-docs", "/swagger**");
    }
    
    ...
 }

最后

代碼（dev2分支）： https://git.oschina.net/seald...

沒有在springmvc中配置成功，原因未知