先介绍一下这个库能干嘛。输入网址:http://localhost:8080/swagger-ui.html
就可以直接返回下面的界面。这个界面是干嘛的呢?其实就是http接口文档的说明。
我们可以借助于两个依赖,就可以实现代码写完,接口的说明文档也就写完了。是不是很厉害。。。反正我是觉得非常给力。
下面来先添加依赖
<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>
然后写一个接口
@RestController
@RequestMapping("/app")
@Api("APP登录接口")
public class posttt {
@PostMapping("login")
@ApiOperation("登录")
public String login() {
return "success";
}
}
另外,还需要写一个SwaggerConfig类
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) //加了ApiOperation注解的方法,生成接口文档
//.apis(RequestHandlerSelectors.basePackage("com.insigma.modules.job.controller")) //包下的类,生成接口文档
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("开源平台")
.description("文档")
.termsOfServiceUrl("http://")
.version("2.0")
.build();
}
然后启动程序,就有上面的截图了。。。