springmvc快速集成swagger

关注

原创最新推荐文章于 2026-04-26 09:20:13 发布 1k 阅读 AI 写同款· GEO 优化 ›

如何整合SpringMVC和Swagger2，并且使用Mock数据进行联调在开发中，我们经常会需要对接口进行联调沟通，然而这是在整个开发周期中最占用时间的一块。尤其最近在接手一个项目中，采用前后端分离开发的模式，写前端的同学完全不懂后台代码（对，我们之前都是一个人写前后端所有相关的代码滴！），接口经常性需要进行调整，基本就是重复沟通，重复浪费时间。于是我决定在项目中引进神器“Swagger”，用来一键生成文档，减少了后端开发同学编写接口文档的时间，同时前端采用Mock数阅读详情

1、先下载swagger https://download.youkuaiyun.com/download/twjjava/10903662

2、导入maven

<dependency>
<groupId>com.mangofactory</groupId>
<artifactId>swagger-springmvc</artifactId>
<version>1.0.2</version>
</dependency>
<dependency>
<groupId>com.mangofactory</groupId>
<artifactId>swagger-models</artifactId>
<version>1.0.2</version>
</dependency>
<dependency>
<groupId>com.wordnik</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.3.11</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.4.4</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.4.4</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.4.4</version>
</dependency>
<dependency>
<groupId>com.fasterxml</groupId>
<artifactId>classmate</artifactId>
<version>1.1.0</version>
</dependency>

3、新建SwaggerConfig 配置类

package com.shop.shop.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

import com.mangofactory.swagger.configuration.SpringSwaggerConfig;
import com.mangofactory.swagger.models.dto.ApiInfo;
import com.mangofactory.swagger.plugin.EnableSwagger;
import com.mangofactory.swagger.plugin.SwaggerSpringMvcPlugin;

@Configuration
@EnableSwagger
public class SwaggerConfig extends WebMvcConfigurerAdapter{
   private SpringSwaggerConfig springSwaggerConfig;

   @Autowired
   public void setSpringSwaggerConfig(SpringSwaggerConfig springSwaggerConfig) {
   this.springSwaggerConfig = springSwaggerConfig;
   }

   @Bean
   public SwaggerSpringMvcPlugin customImplementation() {
   return new SwaggerSpringMvcPlugin(this.springSwaggerConfig).apiInfo(apiInfo()).includePatterns(".*?");
   }

   private ApiInfo apiInfo() {
   ApiInfo apiInfo = new ApiInfo("My Apps API Title", "My Apps API Description", "My Apps API terms of service",
   "My Apps API Contact Email", "My Apps API Licence Type", "My Apps API License URL");
   return apiInfo;
   }
}

4、spring-mvc.xml里面添加如下几行

<mvc:annotation-driven /> 启用注解

<mvc:resources mapping="/swagger/**" location="/WEB-INF/swagger/"/>

5、在WEB-INF下面新建swagger文件夹将下载的swagger文件夹的dist目录下的文件拷贝到新建文件夹下面

6、修改index.html文件

7 、在controller里面启用注解

   @ResponseBody
   @ApiOperation(value = "根据用户名获取用户对象", httpMethod = "GET", response = Map.class, notes = "根据用户名获取用户对象")
   @RequestMapping("/user/get")
   public Map<String, Object> get() {
       Map<String, Object> map = new HashMap<String, Object>();
       map.put("data", userService.get(1l));
       map.put("code", Code.SUC);
       return map;
   }

最后访问

http://localhost:8082/swagger/index.html

收录于