Skip to content
This repository was archived by the owner on Dec 4, 2025. It is now read-only.

Commit 790651a

Browse files
authored
Merge pull request #1057 from netdied/master
Fix issue 1046
2 parents 4f6203d + d4e1e83 commit 790651a

File tree

4 files changed

+15
-4
lines changed

4 files changed

+15
-4
lines changed

src/main/java/com/ly/doc/builder/openapi/AbstractOpenApiBuilder.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,9 @@ public Map<String, Object> buildPaths(ApiConfig apiConfig, ApiSchema<ApiDoc> api
155155
String[] paths = methodDoc.getPath().split(";");
156156
for (String path : paths) {
157157
path = path.trim();
158+
if (StringUtil.isNotEmpty(apiConfig.getPathPrefix())) {
159+
path = path.replace(apiConfig.getPathPrefix(), "");
160+
}
158161
Map<String, Object> request = this.buildPathUrls(apiConfig, methodDoc, methodDoc.getClazzDoc(),
159162
apiSchema.getApiExceptionStatuses());
160163
if (!pathMap.containsKey(path)) {

src/main/java/com/ly/doc/template/IRestDocTemplate.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ default void handleApiDoc(JavaClass cls, List<ApiDoc> apiDocList, List<ApiMethod
284284
apiDoc.setAlias(name);
285285
}
286286
String desc = DocUtil.getEscapeAndCleanComment(cls.getComment());
287-
apiDoc.setDesc(desc);
287+
apiDoc.setDesc(StringUtil.isEmpty(desc) ? controllerName : desc);
288288
apiDoc.setList(apiMethodDocs);
289289
apiDocList.add(apiDoc);
290290

@@ -822,6 +822,9 @@ else if (Objects.nonNull(classMediaType)) {
822822
if (StringUtil.isEmpty(common)) {
823823
common = JavaClassUtil.getSameSignatureMethodCommonFromInterface(cls, method);
824824
}
825+
if (StringUtil.isEmpty(common)) {
826+
common = apiMethodDoc.getName();
827+
}
825828
apiMethodDoc.setDesc(common);
826829
apiMethodDoc.setAuthor(docJavaMethod.getAuthor());
827830
apiMethodDoc.setDetail(docJavaMethod.getDetail());

src/main/java/com/ly/doc/template/JAXRSDocBuildTemplate.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,9 @@ private List<ApiMethodDoc> buildControllerMethod(final JavaClass cls, ApiConfig
217217
methodOrder++;
218218
apiMethodDoc.setName(method.getName());
219219
apiMethodDoc.setOrder(methodOrder);
220-
apiMethodDoc.setDesc(docJavaMethod.getDesc());
220+
String desc = StringUtil.isEmpty(docJavaMethod.getDesc()) ? docJavaMethod.getClass().getName()
221+
: docJavaMethod.getDesc();
222+
apiMethodDoc.setDesc(desc);
221223
String methodUid = DocUtil.generateId(clzName + method.getName() + methodOrder);
222224
apiMethodDoc.setMethodId(methodUid);
223225
apiMethodDoc.setAuthor(docJavaMethod.getAuthor());

src/main/java/com/ly/doc/utils/DocUtil.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1208,7 +1208,9 @@ public static List<ApiDocDict> buildDictionary(ApiConfig config, JavaProjectBuil
12081208
DocletTag apiNoteTag = javaClass.getTagByName(DocTags.API_NOTE);
12091209
ApiDocDict apiDocDict = new ApiDocDict();
12101210
apiDocDict.setOrder(order++);
1211-
apiDocDict.setTitle(javaClass.getComment());
1211+
String title = StringUtils.isBlank(javaClass.getComment()) ? javaClass.getName()
1212+
: javaClass.getComment();
1213+
apiDocDict.setTitle(title);
12121214
apiDocDict.setDescription(DocUtil.getEscapeAndCleanComment(
12131215
Optional.ofNullable(apiNoteTag).map(DocletTag::getValue).orElse(StringUtil.EMPTY)));
12141216
List<DataDict> enumDictionaryList = EnumUtil.getEnumInformation(enumClass,
@@ -1230,7 +1232,8 @@ public static List<ApiDocDict> buildDictionary(ApiConfig config, JavaProjectBuil
12301232
apiDocDict.setDescription(DocUtil.getEscapeAndCleanComment(
12311233
Optional.ofNullable(apiNoteTag).map(DocletTag::getValue).orElse(StringUtil.EMPTY)));
12321234
if (apiDataDictionary.getTitle() == null) {
1233-
apiDocDict.setTitle(javaClass.getComment());
1235+
apiDocDict.setTitle(StringUtils.isBlank(javaClass.getComment()) ? javaClass.getName()
1236+
: javaClass.getComment());
12341237
}
12351238
List<DataDict> enumDictionaryList = EnumUtil.getEnumInformation(clazz,
12361239
apiDataDictionary.getCodeField(), apiDataDictionary.getDescField());

0 commit comments

Comments
 (0)