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/"/>
<bean class="com.shop.shop.config.SwaggerConfig" />
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;
}
最后访问