引入依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.8.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.8.0</version>
</dependency>
通常和springboot web搭配
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
配置
import org.springframework.context.annotation.Configuration;
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;
/**
- swaggger 配置类
- @author peter
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
public Docket restfulAPI() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
.apis(RequestHandlerSelectors.basePackage("your controller package")).paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("your title").description("your description").termsOfServiceUrl("联系地址").version("1.0")
.contact(new Contact("name", "url", "your email")).build();
}
}
应用
import javax.annotation.Resource;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
@RestController
@RequestMapping(“yourservice”)
@Api(“vin码服务接口”)
public class YourController {
@Resource
private YourNService service;
/**
* 获取vin信息
* @param vin
* @return
*/
@ApiOperation(value = "xxx服务", httpMethod = "POST", notes = "xxx服务")
@ApiImplicitParams({@ApiImplicitParam( name = "name", value = "名称", required = true)})
@RequestMapping(value = "test", method = RequestMethod.POST)
public String test(String name) {
return name;
}
}
启动项目后在浏览器中输入:http://localhost:8080/swagger-ui.html
找到对应的接口,点击try it out 调试
在请求模块输入值,点击【execute】按钮执行。
总结
集成三步骤
1、pom加入swagger依赖
2、工程实现swagger配置类
3、在controller中注解应用