Skip to content

feat: Add allowSelfReference configuration to control self-reference … #1065

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat: Add allowSelfReference configuration to control self-reference … #1065

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af779f7
feat: Add allowSelfReference configuration to control self-reference …
PeiRunWu May 31, 2025
77baca3
Merge branch 'master' into master
PeiRunWu May 31, 2025
28ac0ac
feat: Add allowSelfReference configuration to control self-reference …
PeiRunWu May 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 39 additions & 13 deletions src/main/java/com/ly/doc/helper/ParamsBuildHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,19 @@ else if (gName.length() == 1) {
}
}
else {
param.setSelfReferenceLoop(true);
// Check configuration for self-reference in collections
if (projectBuilder.getApiConfig().isAllowSelfReference()) {
// Allow limited recursion when enabled
if (level < 2) {
paramList.addAll(buildParams(gName, preBuilder.toString(), nextLevel, isRequired,
isResp, registryClasses, projectBuilder, groupClasses,
methodJsonViewClasses, fieldPid, jsonRequest, atomicInteger));
}
}
else {
// Original behavior: set self reference loop
param.setSelfReferenceLoop(true);
}
}
}

Expand Down Expand Up @@ -624,18 +636,32 @@ else if (gicName.contains("<")) {
}
}
else if (simpleName.equals(subTypeName)) {
// reference self
ApiParam param1 = ApiParam.of()
.setField(pre + fieldName)
.setPid(pid)
.setId(atomicOrDefault(atomicInteger, paramList.size() + pid + 1))
.setClassName(subTypeName)
.setMaxLength(maxLength)
.setType(ParamTypeConstants.PARAM_TYPE_OBJECT)
.setDesc(comment.append(" $ref... self").toString())
.setVersion(DocGlobalConstants.DEFAULT_VERSION)
.setExtensions(extensionParams);
paramList.add(param1);
// reference self - check configuration
if (projectBuilder.getApiConfig().isAllowSelfReference()) {
// Allow limited recursion when enabled
processApiParam(paramList, param, isRequired, comment + appendComment, since, strRequired);
fieldPid = Optional.ofNullable(atomicInteger).isPresent() ? param.getId()
: paramList.size() + pid;
if (level < 2) {
paramList.addAll(buildParams(fieldGicName, preBuilder.toString(), nextLevel, isRequired,
isResp, registryClasses, projectBuilder, groupClasses, methodJsonViewClasses,
fieldPid, jsonRequest, atomicInteger));
}
}
else {
// Original behavior: create reference parameter
ApiParam param1 = ApiParam.of()
.setField(pre + fieldName)
.setPid(pid)
.setId(atomicOrDefault(atomicInteger, paramList.size() + pid + 1))
.setClassName(subTypeName)
.setMaxLength(maxLength)
.setType(ParamTypeConstants.PARAM_TYPE_OBJECT)
.setDesc(comment.append(" $ref... self").toString())
.setVersion(DocGlobalConstants.DEFAULT_VERSION)
.setExtensions(extensionParams);
paramList.add(param1);
}
}
else {
processApiParam(paramList, param, isRequired, comment + appendComment, since, strRequired);
Expand Down
15 changes: 15 additions & 0 deletions src/main/java/com/ly/doc/model/ApiConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,6 +496,13 @@ public class ApiConfig {
*/
private boolean enumConvertor = Boolean.FALSE;

/**
* allow self reference recursion
*
* @since 3.1.0
*/
private boolean allowSelfReference = Boolean.FALSE;

public static ApiConfig getInstance() {
return instance;
}
Expand Down Expand Up @@ -1185,6 +1192,14 @@ public void setEnumConvertor(boolean enumConvertor) {
this.enumConvertor = enumConvertor;
}

public boolean isAllowSelfReference() {
return allowSelfReference;
}

public void setAllowSelfReference(boolean allowSelfReference) {
this.allowSelfReference = allowSelfReference;
}

public OpenApiTagNameTypeEnum getOpenApiTagNameType() {
return openApiTagNameType;
}
Expand Down