一、spring boot项目创建并引入swagger-ui所需jar包
dependencies {
// https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 compile group: 'io.springfox', name: 'springfox-swagger2', version: '2.7.0' // https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui compile group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.7.0'
}
二、配置swagger-ui
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
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;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.pathMapping("/")
.select() // 选择那些路径和api会生成document
.apis(RequestHandlerSelectors.any())// 对所有api进行监控
.apis(RequestHandlerSelectors.basePackage("com.controller")) // 选择要扫描控制类所在的jar包
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("swagger ui")
.description("测试swagger-ui")
.termsOfServiceUrl("http://www.gm.com")
.contact(new Contact("有问题？点 ↓", "https://www.baidu.com/", "[email protected]"))
.version("1.0")
.build();
}
}
三、创建controller类
import com.bean.Clothing;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
@Api(description = "TestController")
@RequestMapping("/test")
@Controller
public class TestController {
@ApiOperation("hello swagger")
@RequestMapping(value = "/saveClothing",method = RequestMethod.POST)
public String saveClothing(Clothing clothing){
return "你好";
}
}
四、运行结果
