springmvc 整合swagger-ui
1.导入所需要的依赖
<dependency>
<groupId>com.mangofactory</groupId>
<artifactId>swagger-springmvc</artifactId>
<version>1.0.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.module</groupId>
<artifactId>jackson-module-kotlin</artifactId>
<version>2.10.2</version>
</dependency>
2.在springmvc.xml进行配置,并加入配置类
1)配置类
package com.dayone.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableWebMvc
@EnableSwagger2
public class MySwaggerConfig {
@Bean
public Docket userApi() {
return new Docket(DocumentationType.SWAGGER_2)
.select() // 选择那些路径和api会生成document
.apis(RequestHandlerSelectors.any()) // 对所有api进行监控
.paths(PathSelectors.any()) // 对所有路径进行监控
.build();
}
@Bean
public RequestMappingInfoHandlerMapping requestMapping(){
return new RequestMappingHandlerMapping();
}
}
2)springmvc.xml配置
<bean class="springfox.documentation.swagger2.configuration.Swagger2DocumentationConfiguration" id="swagger2Config"/>
将swagger引入IOC容器
开始使用
在要进行测试的controller层上加注解@Api(value = “restful”, description = “测试”)
要测试的接口加@ApiOperation(value = “测试专用”)
package com.dayone.controller;
import com.dayone.dao.RecipeDao;
import com.dayone.pojo.Recipe;
import com.dayone.pojo.test;
import com.dayone.service.RecipeService;
import com.dayone.service.TestService;
import com.wordnik.swagger.annotations.ApiOperation;
import io.swagger.annotations.Api;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.UUID;
@Api(value = "restful", description = "测试")
@Controller
@RequestMapping("/recipe")
public class RecipeController {
@Autowired
private RecipeService recipeService;
@RequestMapping("/upload")
public String insertRecipe(Recipe recipe, Model model) throws IOException {
//保存数据库的路径
String sqlPath = null;
//定义文件保存的本地路径
String localPath = "D:\\test3\\src\\main\\web\\static";
//定义 文件名
String filename = null;
if (!recipe.getFile().isEmpty()) {
//生成uuid作为文件名称
String uuid = UUID.randomUUID().toString().replaceAll("-", "");
//获得文件类型(可以判断如果不是图片,禁止上传)
String contentType = recipe.getFile().getContentType();
//获得文件后缀名
String suffixName = contentType.substring(contentType.indexOf("/") + 1);
//得到 文件名
filename = uuid + "." + suffixName;
//文件保存路径
recipe.getFile().transferTo(new File(localPath+ "/" + filename));
}
//把图片的相对路径保存至数据库
sqlPath = "static/" + filename;
recipe.setPicture(sqlPath);
recipeService.insertRecipe(recipe);
model.addAttribute("picture",recipe.getPicture());
model.addAttribute("message","上传成功!");
return "index.html";
}
@ApiOperation(value = "测试专用")
@Transactional
@RequestMapping("hot")
public String hotRecipe(Model model) {
List<Recipe> recipes = recipeService.hotRecipe();
System.out.println(recipes);
model.addAttribute("recipes",recipes);
return "index.html";
}
@Autowired
private TestService testService;
@ApiOperation(value = "测试专用")
@Transactional
@RequestMapping("text")
public String text(Model model) {
List<test> test = testService.selectText();
test test1 = new test();
model.addAttribute("test1",test);
return "index.html";
}
@ApiOperation(value = "测试专用")
@Transactional
@RequestMapping("/test")
public String test(test test,Model model) {
int test1 = testService.insertStep(test);
model.addAttribute("test",test);
return "index.html";
}
}
就可以得到如下页面