美文网首页- [ Spring Boot ]
Springboot集成swagger-ui

Springboot集成swagger-ui

作者: 好多可乐 | 来源:发表于2021-02-23 00:14 被阅读0次

    一,pom.xml引入依赖,注意依赖版本

    <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger2</artifactId>
       <version>2.9.2</version>
    </dependency>
    <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger-ui</artifactId>
       <version>2.9.2</version>
    </dependency>
    

    二,在SpringBoot 项目主方法文件中引入@EnableSwagger2 注解
    开启Swagger 能力,自动生成API文档

    在这里插入图片描述
    三,对配置依赖进行配置(模板代码,直接将文件复制过来就可以)

    注意--添加注解

    
    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.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    
    @Configuration
    public class SpringFoxConfig {
    
        //访问http://localhost:8083/swagger-ui.html可以看到API文档
        @Bean
        public Docket api() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.any())
                    .paths(PathSelectors.any())
                    .build();
        }
    
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("慕慕生鲜")
                    .description("")
                    .termsOfServiceUrl("")
                    .build();
        }
    }
    
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
    
    /**
     * 描述:     配置地址映射
     */
    @Configuration
    public class MallWebMvcConfig implements WebMvcConfigurer {
    
        @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/");
        }
    }
    
    

    四,在要生成API 文档的方法上,添加@ApiOperation注解

    在这里插入图片描述
    五,运行程序,查看Api文档
    如:http://localhost:8083/swagger-ui.html#/
    在这里插入图片描述

    相关文章

      网友评论

        本文标题:Springboot集成swagger-ui

        本文链接:https://www.haomeiwen.com/subject/skmlfltx.html