学习目标:
pom.xml
<!-- swagger2 配置 第三个是为了优化页面用 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<!--swaggerUI框架-->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.4</version>
</dependency>
SwaggerConfig.java
import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
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;
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI //加密码 -可自选
@Profile({"dev","test","prd"}) //访问环境 -可自选
public class SwaggerConfig {
//http://localhost:8088/swagger-ui.html 原路径
//http://localhost:8088/doc.html bootstarp路径
//配置swagger2核心配置 docket,主要是添加要扫描controller的路径
@Bean
public Docket createRestApi(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.phfund.digital.portal.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("使用Swagger2构建RESTful APIs")
.contact(new Contact("wangqiubo","https://blog.csdn.net/weixin_43931918?type=blog","wqb268@yeah.net"))
.description("xxx......")
.version("1.0.0")
.termsOfServiceUrl("https://localhost:8080/#/index")
.build();
}
}
配置登录权限
#---------------------------------swagger配置开始---------------------------------------------
swagger.production=false
swagger.basic.enable=true
swagger.basic.username=admin
swagger.basic.password=admin
#---------------------------------swagger配置结束---------------------------------------------