springboot和SSM配置swagger笔记（笔记分享，亲测有效）

女爷i 2022-11-18 05:49 199阅读 0赞

### 首先是springboot的 ###

需要导入的架包：

<dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-swagger2</artifactId>
          <version>2.7.0</version>
          <scope>provided </scope>
        </dependency>
        <dependency>
          <groupId>io.springfox</groupId>
          <artifactId>springfox-swagger-ui</artifactId>
          <version>2.7.0</version>
          <scope>provided </scope>
        </dependency>

加入的配置类：

package com.atguigu.servicebase;
    
    import com.google.common.base.Predicates;
    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.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;
    
    /** * @author thunder * @version 1.0.0 * @description */
    @Configuration //配置类
    @EnableSwagger2 //swagger注解
    public class SwaggerConfig { 
    
        @Bean
        public Docket webApiConfig(){ 
            return new Docket(DocumentationType.SWAGGER_2)
                    .groupName("webApi")
                    .apiInfo(webApiInfo())
                    .select()
                    .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                    .paths(Predicates.not(PathSelectors.regex("/error.*")))
                    .build();
    
        }
    
        private ApiInfo webApiInfo(){ 
    
            return new ApiInfoBuilder()
                    .title("网站-课程中心API文档")
                    .description("本文档描述了课程中心微服务接口定义")
                    .version("1.0")
                    .contact(new Contact("java", "http://atguigu.com", "1123@qq.com"))
                    .build();
        }
    }

接着需要在启动类中加上一个注解：

@ComponentScan(basePackages = { "com.atguigu"}) //配置自动扫描swagger配置类

让它自动扫描所有的包，即使在不同是模块也是可以有效果

/** * @author thunder * @version 1.0.0 * @description */
    @SpringBootApplication
    @ComponentScan(basePackages = { "com.atguigu"}) //配置自动扫描swagger配置类
    public class EduApplication { 
    
      public static void main(String[] args) { 
        SpringApplication.run(EduApplication.class, args);
      }
    }

运行启动之后访问的地址模板：

http://localhost:8001/swagger-ui.html

### 接着是SSM版本的 ###

首先搭建好ssm框架  
接着引入pom文件这里降低了版本：

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

在编辑配置类：

package com.fuyuan.ssm.config;
    
    import com.google.common.base.Predicates;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.ComponentScan;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.EnableWebMvc;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    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;
    
    /** * @author huiXing * @version 1.0.0 * @description */
    /*@Configuration //配置类 @EnableSwagger2 //swagger注解*/
    
    @EnableSwagger2
    @EnableWebMvc
    @Configuration
    @ComponentScan(basePackages ="com.fuyuan.ssm.controller")
    public class SwaggerConfig { 
    
        @Bean
        public Docket webApiConfig(){ 
            return new Docket(DocumentationType.SWAGGER_2)
                    .groupName("webApi")
                    .apiInfo(webApiInfo())
                    .select()
                    .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                    .paths(Predicates.not(PathSelectors.regex("/error.*")))
                    .build();
        }
    
        private ApiInfo webApiInfo(){ 
    
            return new ApiInfoBuilder()
                    .title("网站-ERP开发-库存-API文档")
                    .description("本文档描述了库存管理的接口定义")
                    .version("1.0")
                    .contact(new Contact("java", "http://fxxxxxxx.com", "1123@qq.com"))
                    .build();
        }
    
    }

需要在springmvc的配置文件里加入这两个配置：

<mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/" />
        <mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/" />

接着就是Controller类里的配置：  
案例

/** * 讲师 前端控制器 * * @author testjava * @since 2021-04-12 */
    @Api(description = "讲师模块")
    @RestController
    @CrossOrigin  //解决跨域的问题
    @RequestMapping("/eduservice/teacher")
    public class EduTeacherController { 
    
      private final EduTeacherService eduTeacherService;
    
      public EduTeacherController(EduTeacherService eduTeacherService) { 
        this.eduTeacherService = eduTeacherService;
      }
    
      // 1、查询讲师表中的所有数据
      //rest风格
      @ApiOperation(value = "所有讲师列表")
      @GetMapping("findAll")
      public R findAllTeacher() { 
        // 调用service的方法实现查询所有的操作
        List<EduTeacher> list = eduTeacherService.list(null);
    
        return R.ok().data("items",list);
      }
      }
      }

想了解更多请跳转传送门[https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md][https_github.com_swagger-api_swagger-ui_blob_master_docs_usage_configuration.md]  
不要问我为啥，没时间解释了，我要立马接着加班了…

[https_github.com_swagger-api_swagger-ui_blob_master_docs_usage_configuration.md]: https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md