1.创建一个springboot项目
2.引入swagger所需要的依赖
<!-- swagger2 接口API文档 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>
</dependencies>
3.编写swagger配置类
package com.sprongboot.boot_mp.config;
import io.swagger.annotations.Api;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
@ComponentScan(basePackages = "com.sprongboot.boot_mp.controller")//配置扫描的基础包
public class SwaggerConfig {
//在构建文档的时候 只显示添加了@Api注解的类
@Bean //作为bean纳入spring容器
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.paths(PathSelectors.any())
.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
.build();
}
private ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("API接口文档")
.description("API接口文档,及相关接口的说明")
.version("1.0.0")
.build();
}
}
4.输入http://localhost:端口号/doc.html
出现该页面表示整合成功