简介:swaggerUI是一个自动生成接口文档的插件
1、在pom文件中添加
<properties>
<swagger.version>2.7.0</swagger.version>
</properties>
<dependencies>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${swagger.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${swagger.version}</version>
</dependency>
</dependencies>
2、新建一个swaggerUI的配置类
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
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 api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.pathMapping("/")
.select()
.paths(PathSelectors.regex("/.*"))
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("我的接口文档")
.contact(new Contact("lucky", "", "666@qq.com"))
.description("这是我的SwaggerUI生成的接口文档")
.version("1.0.0.0")
.build();
}
}
3、在接口类上添加标签
@Api(value = "/",description = "这是全部的get方法")
在每个get方法上添加标签
@ApiOperation(value = "通过这个方法获得cookie值",httpMethod = "GET")
4、在chrome浏览器输入url:http://localhost:8888/swagger-ui.html
可以查看到生成的接口文档