opensource/RuoYi-Vue-Plus
2
0
Fork 1
mirror of https://gitee.com/dromara/RuoYi-Vue-Plus.git synced 2026-09-19 01:48:47 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

update 增强接口描述，合并JavaDoc权限信息到操作描述中

Browse Source
This commit is contained in:
AprilWind 2026-03-05 14:40:30 +08:00
parent 3e08d94dbc
commit 3b510c057d
2 changed files with 10 additions and 1560 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
ruoyi-common/ruoyi-common-doc/src/main/java/org/dromara/common/doc/handler/OpenApiHandler.java
View File

@ -11,7 +11,6 @@ import io.swagger.v3.oas.models.Paths;
import io.swagger.v3.oas.models.tags.Tag; import io.swagger.v3.oas.models.tags.Tag;
import lombok.extern.slf4j.Slf4j; import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
import org.dromara.common.core.utils.ObjectUtils;
import org.dromara.common.core.utils.StreamUtils; import org.dromara.common.core.utils.StreamUtils;
import org.dromara.common.doc.core.enhancer.SaTokenMetadataResolver; import org.dromara.common.doc.core.enhancer.SaTokenMetadataResolver;
import org.dromara.common.doc.core.model.SaTokenSecurityMetadata; import org.dromara.common.doc.core.model.SaTokenSecurityMetadata;
@ -229,14 +228,21 @@ public class OpenApiHandler extends OpenAPIService {
else else
securityParser.buildSecurityRequirement(securityRequirements, operation); securityParser.buildSecurityRequirement(securityRequirements, operation);
} }
String description = javadocProvider.get().getMethodJavadocDescription(handlerMethod.getMethod());
String summary = javadocProvider.get().getFirstSentence(description);
if (StringUtils.isNotBlank(description)){
operation.setSummary(summary);
}
// 调用SaToken解析器提取JavaDoc中的权限信息 // 调用SaToken解析器提取JavaDoc中的权限信息
if (saTokenJavadocResolver.supports(handlerMethod)) { if (saTokenJavadocResolver.supports(handlerMethod)) {
SaTokenSecurityMetadata metadata = new SaTokenSecurityMetadata(); SaTokenSecurityMetadata metadata = new SaTokenSecurityMetadata();
saTokenJavadocResolver.resolve(handlerMethod, operation, metadata); saTokenJavadocResolver.resolve(handlerMethod, operation, metadata);
operation.setDescription(metadata.toMarkdownString()); String markdownString = metadata.toMarkdownString();
if (StringUtils.isNotBlank(markdownString)) {
description = description + markdownString;
}
} }
operation.setDescription(description);
return operation; return operation;
} }

1556
ruoyi-common/ruoyi-common-doc/src/main/java/org/springdoc/api/AbstractOpenApiResource.java
View File

File diff suppressed because it is too large Load Diff