update 删除一些跟swagger有关的字眼 避免误解

This commit is contained in:
疯狂的狮子Li
2023-07-25 13:06:41 +08:00
parent f4332aea02
commit 51ab321dcf
4 changed files with 23 additions and 27 deletions

View File

@@ -245,8 +245,13 @@ mybatis-encryptor:
publicKey:
privateKey:
# swagger配置
swagger:
springdoc:
api-docs:
# 是否开启接口文档
enabled: true
# swagger-ui:
# # 持久化认证数据
# persistAuthorization: true
info:
# 标题
title: '标题RuoYi-Cloud-Plus微服务权限管理系统_接口文档'
@@ -271,14 +276,6 @@ swagger:
service-mapping:
ruoyi-gen: /code
springdoc:
api-docs:
# 是否开启接口文档
enabled: true
swagger-ui:
# 持久化认证数据
persistAuthorization: true
# seata配置
seata:
# 默认关闭如需启用spring.datasource.dynami.seata需要同时开启

View File

@@ -1,7 +1,7 @@
package com.ruoyi.common.doc.config;
import com.ruoyi.common.core.utils.StringUtils;
import com.ruoyi.common.doc.config.properties.SwaggerProperties;
import com.ruoyi.common.doc.config.properties.SpringDocProperties;
import com.ruoyi.common.doc.handler.OpenApiHandler;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.Paths;
@@ -30,12 +30,11 @@ import java.util.*;
*/
@RequiredArgsConstructor
@AutoConfiguration(before = SpringDocConfiguration.class)
@EnableConfigurationProperties(SwaggerProperties.class)
@EnableConfigurationProperties(SpringDocProperties.class)
@ConditionalOnProperty(name = "springdoc.api-docs.enabled", havingValue = "true", matchIfMissing = true)
public class SwaggerAutoConfiguration {
private final SwaggerProperties swaggerProperties;
public class SpringDocAutoConfiguration {
private final SpringDocProperties properties;
private final ServerProperties serverProperties;
@Value("${spring.application.name}")
@@ -43,18 +42,18 @@ public class SwaggerAutoConfiguration {
@Bean
@ConditionalOnMissingBean(OpenAPI.class)
public OpenAPI openApi() {
public OpenAPI openApi(SpringDocProperties properties) {
OpenAPI openApi = new OpenAPI();
// 文档基本信息
SwaggerProperties.InfoProperties infoProperties = swaggerProperties.getInfo();
SpringDocProperties.InfoProperties infoProperties = properties.getInfo();
Info info = convertInfo(infoProperties);
openApi.info(info);
// 扩展文档信息
openApi.externalDocs(swaggerProperties.getExternalDocs());
openApi.tags(swaggerProperties.getTags());
openApi.paths(swaggerProperties.getPaths());
openApi.components(swaggerProperties.getComponents());
Set<String> keySet = swaggerProperties.getComponents().getSecuritySchemes().keySet();
openApi.externalDocs(properties.getExternalDocs());
openApi.tags(properties.getTags());
openApi.paths(properties.getPaths());
openApi.components(properties.getComponents());
Set<String> keySet = properties.getComponents().getSecuritySchemes().keySet();
List<SecurityRequirement> list = new ArrayList<>();
SecurityRequirement securityRequirement = new SecurityRequirement();
keySet.forEach(securityRequirement::addList);
@@ -64,7 +63,7 @@ public class SwaggerAutoConfiguration {
return openApi;
}
private Info convertInfo(SwaggerProperties.InfoProperties infoProperties) {
private Info convertInfo(SpringDocProperties.InfoProperties infoProperties) {
Info info = new Info();
info.setTitle(infoProperties.getTitle());
info.setDescription(infoProperties.getDescription());
@@ -92,7 +91,7 @@ public class SwaggerAutoConfiguration {
@Bean
public OpenApiCustomiser openApiCustomiser() {
// 如果服务的自定义 Path 不存在 则采用默认去除前缀当 Path
Map<String, String> serviceMapping = swaggerProperties.getServiceMapping();
Map<String, String> serviceMapping = properties.getServiceMapping();
String appPath;
if (serviceMapping.containsKey(appName)) {
appPath = serviceMapping.get(appName);

View File

@@ -19,8 +19,8 @@ import java.util.Map;
* @author Lion Li
*/
@Data
@ConfigurationProperties(prefix = "swagger")
public class SwaggerProperties {
@ConfigurationProperties(prefix = "springdoc")
public class SpringDocProperties {
/**
* 文档基本信息

View File

@@ -1 +1 @@
com.ruoyi.common.doc.config.SwaggerAutoConfiguration
com.ruoyi.common.doc.config.SpringDocAutoConfiguration