文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

Spring 4.2.2以上版本和swagger集成方案和踩过的坑

2023-06-05 04:58

关注

因为公司使用的spring版本太高,在集成swagger的时候会存在一些问题,而网上的很多实例大多都是版本比较低的,为了使朋友们少踩坑,我这边将集成的过程记录一下:

引入spring、swagger的相关jar包(springfox-swagger2、springfox-swagger-ui),在pom.xml中配置:

<dependency>              <groupId>io.springfox</groupId>              <artifactId>springfox-swagger2</artifactId>              <version>2.4.0</version>              <exclusions>                  <exclusion>                      <groupId>org.springframework</groupId>                      <artifactId>spring-core</artifactId>                  </exclusion>                  <exclusion>                      <groupId>org.springframework</groupId>                      <artifactId>spring-beans</artifactId>                  </exclusion>                  <exclusion>                      <groupId>org.springframework</groupId>                      <artifactId>spring-context</artifactId>                  </exclusion>                  <exclusion>                      <groupId>org.springframework</groupId>                      <artifactId>spring-context-support</artifactId>                  </exclusion>                  <exclusion>                      <groupId>org.springframework</groupId>                      <artifactId>spring-aop</artifactId>                  </exclusion>                  <exclusion>                      <groupId>org.springframework</groupId>                      <artifactId>spring-tx</artifactId>                  </exclusion>                  <exclusion>                      <groupId>org.springframework</groupId>                      <artifactId>spring-orm</artifactId>                  </exclusion>                  <exclusion>                      <groupId>org.springframework</groupId>                      <artifactId>spring-jdbc</artifactId>                  </exclusion>                  <exclusion>                      <groupId>org.springframework</groupId>                      <artifactId>spring-web</artifactId>                  </exclusion>                  <exclusion>                      <groupId>org.springframework</groupId>                      <artifactId>spring-webmvc</artifactId>                  </exclusion>                  <exclusion>                      <groupId>org.springframework</groupId>                      <artifactId>spring-oxm</artifactId>                  </exclusion>              </exclusions>          </dependency>          <dependency>              <groupId>io.springfox</groupId>              <artifactId>springfox-swagger-ui</artifactId>              <version>2.4.0</version>          </dependency>

提醒: 特别注意,springfox-swagger2在集成的时候,已经引入了spring的相关jar,特别是spring-context、spring-context-support的版本和项目中使用的版本完全不一致,项目在启动的时候出现很多包冲突的问题,这边在引入pom.xml文件的时候过滤掉了spring的相关jar包。

编写Swagger的配置类:

package com.ml.honghu.swagger.web;    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.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;    @EnableWebMvc  @EnableSwagger2  @Configuration  @ComponentScan(basePackages ={"com.ml.honghu.**.rest"})  public class SwaggerConfig {      @Bean      public Docket createRestApi() {          return new Docket(DocumentationType.SWAGGER_2)                  .apiInfo(apiInfo())                  .select()                  .apis(RequestHandlerSelectors.basePackage("com.ml.honghu"))                  .paths(PathSelectors.any())                  .build();      }        private ApiInfo apiInfo() {          return new ApiInfoBuilder()                  .title("接口列表 v1.0")                  .description("接口信息")                  .termsOfServiceUrl("http://honghu.com")                  .contact(new Contact("", "", "HongHu"))                  .version("1.1.0")                  .build();      }  }

在spring-mvc.xml文件中进行过滤器的配置,过滤掉swagger的相关访问配置:

<mvc:exclude-mapping path="/swagger*/**"/>  <mvc:exclude-mapping path="/v2/**"/>  <mvc:exclude-mapping path="/webjars/**"/>

服务配置项

@Api("区域服务")@RestController  @RequestMapping(value = "/rest/area")  public class AreaService  {        @Autowired      private AreaService areaService;            <span style="color: #ff0000;">@ApiOperation(value = "区域列表", httpMethod = "GET", notes = "区域列表")</span>      @IsLogin      @ResponseBody      @RequestMapping(value = "treeData", method = RequestMethod.GET)      public List<Map<String, Object>> treeData(              <span style="color: #ff0000;">@ApiParam(required = true, value = "区域ID")</span>  @RequestParam(required=false) String extId, HttpServletResponse response) {          List<Map<String, Object>> mapList = Lists.newArrayList();          List<Area> list = areaService.findAll();          for (int i=0; i<list.size(); i++){              Area e = list.get(i);              if (StringUtils.isBlank(extId) || (extId!=null && !extId.equals(e.getId()) && e.getParentIds().indexOf(","+extId+",")==-1)){                  Map<String, Object> map = Maps.newHashMap();                  map.put("id", e.getId());                  map.put("pId", e.getParentId());                  map.put("name", e.getName());                  mapList.add(map);              }          }          return mapList;      }  }

启动项目,查看结果:

Spring 4.2.2以上版本和swagger集成方案和踩过的坑资料和源码来源 

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯