|
@@ -1,20 +1,13 @@
|
|
|
package com.fs.core.config;
|
|
|
|
|
|
import com.fs.common.config.FSConfig;
|
|
|
-import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
|
|
|
import io.swagger.annotations.ApiOperation;
|
|
|
+import io.swagger.v3.oas.models.OpenAPI;
|
|
|
+import io.swagger.v3.oas.models.info.Info;
|
|
|
import org.springframework.beans.factory.annotation.Autowired;
|
|
|
import org.springframework.beans.factory.annotation.Value;
|
|
|
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.builders.RequestHandlerSelectors;
|
|
|
-import springfox.documentation.service.*;
|
|
|
-import springfox.documentation.spi.DocumentationType;
|
|
|
-import springfox.documentation.spi.service.contexts.SecurityContext;
|
|
|
-import springfox.documentation.spring.web.plugins.Docket;
|
|
|
-import springfox.documentation.swagger2.annotations.EnableSwagger2;
|
|
|
|
|
|
import java.util.ArrayList;
|
|
|
import java.util.List;
|
|
@@ -25,8 +18,6 @@ import java.util.List;
|
|
|
|
|
|
*/
|
|
|
@Configuration
|
|
|
-@EnableSwagger2
|
|
|
-@EnableSwaggerBootstrapUI
|
|
|
public class SwaggerConfig
|
|
|
{
|
|
|
/** 系统基础配置 */
|
|
@@ -41,84 +32,92 @@ public class SwaggerConfig
|
|
|
@Value("${swagger.pathMapping}")
|
|
|
private String pathMapping;
|
|
|
|
|
|
- /**
|
|
|
- * 创建API
|
|
|
- */
|
|
|
@Bean
|
|
|
- public Docket createRestApi()
|
|
|
- {
|
|
|
- return new Docket(DocumentationType.SWAGGER_2)
|
|
|
- // 是否启用Swagger
|
|
|
- .enable(enabled)
|
|
|
- // 用来创建该API的基本信息,展示在文档的页面中(自定义展示的信息)
|
|
|
- .apiInfo(apiInfo())
|
|
|
- // 设置哪些接口暴露给Swagger展示
|
|
|
- .select()
|
|
|
- // 扫描所有有注解的api,用这种方式更灵活
|
|
|
- .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
|
|
|
- // 扫描指定包中的swagger注解
|
|
|
- // .apis(RequestHandlerSelectors.basePackage("com.fs.project.tool.swagger"))
|
|
|
- // 扫描所有 .apis(RequestHandlerSelectors.any())
|
|
|
- .paths(PathSelectors.any())
|
|
|
- .build()
|
|
|
- /* 设置安全模式,swagger可以设置访问token */
|
|
|
- .securitySchemes(securitySchemes())
|
|
|
- .securityContexts(securityContexts())
|
|
|
- .pathMapping(pathMapping);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * 安全模式,这里指定token通过Authorization头请求头传递
|
|
|
- */
|
|
|
- private List<ApiKey> securitySchemes()
|
|
|
- {
|
|
|
- List<ApiKey> apiKeyList = new ArrayList<ApiKey>();
|
|
|
- apiKeyList.add(new ApiKey("Authorization", "AppToken", "header"));
|
|
|
- return apiKeyList;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * 安全上下文
|
|
|
- */
|
|
|
- private List<SecurityContext> securityContexts()
|
|
|
- {
|
|
|
- List<SecurityContext> securityContexts = new ArrayList<>();
|
|
|
- securityContexts.add(
|
|
|
- SecurityContext.builder()
|
|
|
- .securityReferences(defaultAuth())
|
|
|
- .forPaths(PathSelectors.regex("^(?!auth).*$"))
|
|
|
- .build());
|
|
|
- return securityContexts;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * 默认的安全上引用
|
|
|
- */
|
|
|
- private List<SecurityReference> defaultAuth()
|
|
|
- {
|
|
|
- AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
|
|
|
- AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
|
|
|
- authorizationScopes[0] = authorizationScope;
|
|
|
- List<SecurityReference> securityReferences = new ArrayList<>();
|
|
|
- securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
|
|
|
- return securityReferences;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * 添加摘要信息
|
|
|
- */
|
|
|
- private ApiInfo apiInfo()
|
|
|
- {
|
|
|
- // 用ApiInfoBuilder进行定制
|
|
|
- return new ApiInfoBuilder()
|
|
|
- // 设置标题
|
|
|
- .title("标题:销售APP_接口文档")
|
|
|
- // 描述
|
|
|
- .description("描述:销售APP接口文档")
|
|
|
- // 作者信息
|
|
|
- .contact(new Contact(fsConfig.getName(), null, null))
|
|
|
- // 版本
|
|
|
- .version("版本号:" + fsConfig.getVersion())
|
|
|
- .build();
|
|
|
+ public OpenAPI customOpenAPI() {
|
|
|
+ return new OpenAPI()
|
|
|
+ .info(new Info()
|
|
|
+ .title("Your API Title")
|
|
|
+ .version("1.0.0")
|
|
|
+ .description("Your API Description"));
|
|
|
}
|
|
|
+// /**
|
|
|
+// * 创建API
|
|
|
+// */
|
|
|
+// @Bean
|
|
|
+// public Docket createRestApi()
|
|
|
+// {
|
|
|
+// return new Docket(DocumentationType.SWAGGER_2)
|
|
|
+// // 是否启用Swagger
|
|
|
+// .enable(enabled)
|
|
|
+// // 用来创建该API的基本信息,展示在文档的页面中(自定义展示的信息)
|
|
|
+// .apiInfo(apiInfo())
|
|
|
+// // 设置哪些接口暴露给Swagger展示
|
|
|
+// .select()
|
|
|
+// // 扫描所有有注解的api,用这种方式更灵活
|
|
|
+// .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
|
|
|
+// // 扫描指定包中的swagger注解
|
|
|
+// // .apis(RequestHandlerSelectors.basePackage("com.fs.project.tool.swagger"))
|
|
|
+// // 扫描所有 .apis(RequestHandlerSelectors.any())
|
|
|
+// .paths(PathSelectors.any())
|
|
|
+// .build()
|
|
|
+// /* 设置安全模式,swagger可以设置访问token */
|
|
|
+// .securitySchemes(securitySchemes())
|
|
|
+// .securityContexts(securityContexts())
|
|
|
+// .pathMapping(pathMapping);
|
|
|
+// }
|
|
|
+//
|
|
|
+// /**
|
|
|
+// * 安全模式,这里指定token通过Authorization头请求头传递
|
|
|
+// */
|
|
|
+// private List<ApiKey> securitySchemes()
|
|
|
+// {
|
|
|
+// List<ApiKey> apiKeyList = new ArrayList<ApiKey>();
|
|
|
+// apiKeyList.add(new ApiKey("Authorization", "AppToken", "header"));
|
|
|
+// return apiKeyList;
|
|
|
+// }
|
|
|
+//
|
|
|
+// /**
|
|
|
+// * 安全上下文
|
|
|
+// */
|
|
|
+// private List<SecurityContext> securityContexts()
|
|
|
+// {
|
|
|
+// List<SecurityContext> securityContexts = new ArrayList<>();
|
|
|
+// securityContexts.add(
|
|
|
+// SecurityContext.builder()
|
|
|
+// .securityReferences(defaultAuth())
|
|
|
+// .forPaths(PathSelectors.regex("^(?!auth).*$"))
|
|
|
+// .build());
|
|
|
+// return securityContexts;
|
|
|
+// }
|
|
|
+//
|
|
|
+// /**
|
|
|
+// * 默认的安全上引用
|
|
|
+// */
|
|
|
+// private List<SecurityReference> defaultAuth()
|
|
|
+// {
|
|
|
+// AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
|
|
|
+// AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
|
|
|
+// authorizationScopes[0] = authorizationScope;
|
|
|
+// List<SecurityReference> securityReferences = new ArrayList<>();
|
|
|
+// securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
|
|
|
+// return securityReferences;
|
|
|
+// }
|
|
|
+//
|
|
|
+// /**
|
|
|
+// * 添加摘要信息
|
|
|
+// */
|
|
|
+// private ApiInfo apiInfo()
|
|
|
+// {
|
|
|
+// // 用ApiInfoBuilder进行定制
|
|
|
+// return new ApiInfoBuilder()
|
|
|
+// // 设置标题
|
|
|
+// .title("标题:销售APP_接口文档")
|
|
|
+// // 描述
|
|
|
+// .description("描述:销售APP接口文档")
|
|
|
+// // 作者信息
|
|
|
+// .contact(new Contact(fsConfig.getName(), null, null))
|
|
|
+// // 版本
|
|
|
+// .version("版本号:" + fsConfig.getVersion())
|
|
|
+// .build();
|
|
|
+// }
|
|
|
}
|