使用SpringBoot集成Swagger3,一遍通!!!

老样子:

 1.添加依赖

这里采用的SpingBoot是2.7.4版本的parent依赖!


    org.springframework.boot
    spring-boot-starter-parent
    2.7.4

swagger依赖:


    io.springfox
    springfox-swagger-ui
    3.0.0


    io.swagger
    swagger-annotations
    1.5.20


    io.springfox
    springfox-swagger2
    3.0.0
    compile

添加依赖----->来一手我们的刷新Pom文件!

2.配置类


@Configuration//配置类
@EnableSwagger2
public class SwaggerConfig  extends WebMvcConfigurationSupport {
    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.XXX.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("网站-课程中心API文档")
                .description("本文档描述了课程中心微服务接口定义")
                .version("1.0")
                .contact(new Contact("java", "url","XXX.qq.com"))
                .build();
    }
//为了防止浏览器拦截我们的静态资源,因此要加一个WebMvc的配置重写一下方法

@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/");

}
@Override
protected void configureMessageConverters(List> converters) {
    converters.add(responseBodyConverter());
    super.configureMessageConverters(converters);
}
@Bean
public HttpMessageConverter responseBodyConverter() {
    StringHttpMessageConverter converter = new StringHttpMessageConverter(Charset.forName("UTF-8"));
    return converter;
}
}

3.启动类

在Application启动类上加一个注解

@EnableWebMvc代表启动我们的配置类(@Configuration的注解类)

4.访问Swagger-ui.html

大功告成!访问一下试试看!

访问http://localhost:port/swagger-ui.html

使用SpringBoot集成Swagger3,一遍通!!!_第1张图片

 

你可能感兴趣的:(spring,boot,后端)