Skip to content
This repository was archived by the owner on Dec 4, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/main/java/com/ly/doc/helper/FormDataBuildHelper.java
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ else if (JavaClassValidateUtil.isPrimitive(subTypeName)) {
formDataList.add(formData);
}
else if (javaClass.isEnum()) {
Object value = JavaClassUtil.getEnumValue(javaClass, builder, Boolean.TRUE);
Object value = JavaClassUtil.getEnumValue(javaClass, builder);
if (tagsMap.containsKey(DocTags.MOCK) && StringUtil.isNotEmpty(tagsMap.get(DocTags.MOCK))) {
value = ParamUtil.formatMockValue(tagsMap.get(DocTags.MOCK));
}
Expand Down
13 changes: 5 additions & 8 deletions src/main/java/com/ly/doc/helper/JsonBuildHelper.java
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,7 @@ public static String buildReturnJson(DocJavaMethod docJavaMethod, ProjectDocConf
return "File download.";
}
if (method.getReturns().isEnum() && Objects.isNull(responseBodyAdvice)) {
return StringUtil
.removeQuotes(String.valueOf(JavaClassUtil.getEnumValue(method.getReturns(), builder, Boolean.FALSE)));
return StringUtil.removeQuotes(String.valueOf(JavaClassUtil.getEnumValue(method.getReturns(), builder)));
}
if (method.getReturns().isPrimitive() && Objects.isNull(responseBodyAdvice)) {
String typeName = method.getReturnType().getCanonicalName();
Expand Down Expand Up @@ -158,8 +157,7 @@ public static String buildJson(String typeName, String genericCanonicalName, boo

// Handle enum types
if (javaClass.isEnum()) {
return StringUtil
.removeQuotes(String.valueOf(JavaClassUtil.getEnumValue(javaClass, projectBuilder, Boolean.FALSE)));
return StringUtil.removeQuotes(String.valueOf(JavaClassUtil.getEnumValue(javaClass, projectBuilder)));
}

StringBuilder result = new StringBuilder();
Expand Down Expand Up @@ -389,8 +387,7 @@ else if (gicName.length() == 1) {
JavaClass arraySubClass = projectBuilder.getJavaProjectBuilder()
.getClassByName(gicName);
if (arraySubClass.isEnum()) {
Object value = JavaClassUtil.getEnumValue(arraySubClass, projectBuilder,
Boolean.FALSE);
Object value = JavaClassUtil.getEnumValue(arraySubClass, projectBuilder);
result.append("[").append(value).append("],");
continue;
}
Expand Down Expand Up @@ -463,15 +460,15 @@ else if (typeName.equals(fieldGicName)) {
// if has Annotation @JsonSerialize And using
// ToStringSerializer && isResp
else if (toStringSerializer && isResp) {
Object value = JavaClassUtil.getEnumValue(javaClass, projectBuilder, Boolean.FALSE);
Object value = JavaClassUtil.getEnumValue(javaClass, projectBuilder);
result.append(value).append(",");
}
// if has @JsonFormat
else if (StringUtil.isNotEmpty(fieldJsonFormatValue)) {
result.append(fieldJsonFormatValue).append(",");
}
else {
Object value = JavaClassUtil.getEnumValue(javaClass, projectBuilder, Boolean.FALSE);
Object value = JavaClassUtil.getEnumValue(javaClass, projectBuilder);
result.append(value).append(",");
}
}
Expand Down
7 changes: 4 additions & 3 deletions src/main/java/com/ly/doc/helper/ParamsBuildHelper.java
Original file line number Diff line number Diff line change
Expand Up @@ -502,12 +502,13 @@ else if (JavaClassValidateUtil.isCollection(subTypeName)
if (arraySubClass.isEnum()) {
comment.append(handleEnumComment(arraySubClass, projectBuilder));
param.setDesc(comment.toString());
param.setType(ParamTypeConstants.PARAM_TYPE_ARRAY);

EnumInfoAndValues enumInfoAndValue = JavaClassUtil.getEnumInfoAndValue(arraySubClass,
projectBuilder, Boolean.FALSE);
projectBuilder);
if (Objects.nonNull(enumInfoAndValue)) {
param.setValue("[\"" + enumInfoAndValue.getValue() + "\"]")
.setEnumInfoAndValues(enumInfoAndValue)
.setType(enumInfoAndValue.getType());
.setEnumInfoAndValues(enumInfoAndValue);
}
}
else if (gName.length() == 1) {
Expand Down
15 changes: 15 additions & 0 deletions src/main/java/com/ly/doc/model/ApiConfig.java
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,13 @@ public class ApiConfig {
*/
private boolean addDefaultHttpStatuses;

/**
* Show enum name for example
*
* @since 3.1.0
*/
private boolean enumNameExample = Boolean.FALSE;

public static ApiConfig getInstance() {
return instance;
}
Expand Down Expand Up @@ -1138,4 +1145,12 @@ public void setAddDefaultHttpStatuses(boolean addDefaultHttpStatuses) {
this.addDefaultHttpStatuses = addDefaultHttpStatuses;
}

public boolean isEnumNameExample() {
return enumNameExample;
}

public void setEnumNameExample(boolean enumNameExample) {
this.enumNameExample = enumNameExample;
}

}
16 changes: 0 additions & 16 deletions src/main/java/com/ly/doc/model/torna/Item.java
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,6 @@ public class Item implements Serializable {
*/
private String description;

/**
* valueObject; A temporary variable used to store the object form of the value. This
* field will not be serialized or deserialized.
*/
@Expose(serialize = false, deserialize = false)
private Object valueObject;

public Item() {
}

Expand All @@ -73,7 +66,6 @@ public Item(String name, String type, String value, String description) {
this.type = type;
this.value = value;
this.description = description;
this.valueObject = name;
}

public String getName() {
Expand Down Expand Up @@ -108,12 +100,4 @@ public void setDescription(String description) {
this.description = description;
}

public Object getValueObject() {
return valueObject;
}

public void setValueObject(Object valueObject) {
this.valueObject = valueObject;
}

}
14 changes: 6 additions & 8 deletions src/main/java/com/ly/doc/template/IRestDocTemplate.java
Original file line number Diff line number Diff line change
Expand Up @@ -1167,8 +1167,7 @@ else if (frameworkAnnotations.getRequestPartAnnotation()
.setQueryParam(isQueryParam)
.setId(paramList.size() + 1)
.setType(ParamTypeConstants.PARAM_TYPE_ARRAY);
EnumInfoAndValues enumInfoAndValue = JavaClassUtil.getEnumInfoAndValue(gicJavaClass, builder,
Boolean.TRUE);
EnumInfoAndValues enumInfoAndValue = JavaClassUtil.getEnumInfoAndValue(gicJavaClass, builder);
if (Objects.nonNull(enumInfoAndValue)) {
param.setValue(StringUtil.removeDoubleQuotes(String.valueOf(enumInfoAndValue.getValue())))
.setEnumInfoAndValues(enumInfoAndValue);
Expand Down Expand Up @@ -1276,8 +1275,7 @@ else if (javaClass.isEnum()) {
.setRequired(required)
.setVersion(DocGlobalConstants.DEFAULT_VERSION);

EnumInfoAndValues enumInfoAndValue = JavaClassUtil.getEnumInfoAndValue(javaClass, builder,
isPathVariable || isQueryParam);
EnumInfoAndValues enumInfoAndValue = JavaClassUtil.getEnumInfoAndValue(javaClass, builder);
if (Objects.nonNull(enumInfoAndValue)) {
param.setValue(StringUtil.removeDoubleQuotes(String.valueOf(enumInfoAndValue.getValue())))
.setEnumInfoAndValues(enumInfoAndValue)
Expand Down Expand Up @@ -1474,7 +1472,7 @@ else if (frameworkAnnotations.getPathVariableAnnotation()
.getAnnotationName()
.contains(annotationName)) {
if (javaClass.isEnum()) {
Object value = JavaClassUtil.getEnumValue(javaClass, configBuilder, Boolean.TRUE);
Object value = JavaClassUtil.getEnumValue(javaClass, configBuilder);
mockValue = StringUtil.removeQuotes(String.valueOf(value));
}
if (pathParamsMap.containsKey(paramName)) {
Expand All @@ -1488,7 +1486,7 @@ else if (frameworkAnnotations.getRequestParamAnnotation()
.getAnnotationName()
.contains(annotationName)) {
if (javaClass.isEnum()) {
Object value = JavaClassUtil.getEnumValue(javaClass, configBuilder, Boolean.TRUE);
Object value = JavaClassUtil.getEnumValue(javaClass, configBuilder);
mockValue = StringUtil.removeQuotes(String.valueOf(value));
}
if (queryParamsMap.containsKey(paramName)) {
Expand Down Expand Up @@ -1565,7 +1563,7 @@ else if (JavaClassValidateUtil.isArray(fullyQualifiedName)
String value;
JavaClass javaClass1 = configBuilder.getClassByName(gicName);
if (Objects.nonNull(javaClass1) && javaClass1.isEnum()) {
value = String.valueOf(JavaClassUtil.getEnumValue(javaClass1, configBuilder, Boolean.TRUE));
value = String.valueOf(JavaClassUtil.getEnumValue(javaClass1, configBuilder));
}
else {
value = RandomUtil.randomValueByType(gicName);
Expand All @@ -1583,7 +1581,7 @@ else if (JavaClassValidateUtil.isArray(fullyQualifiedName)
// enum type
else if (javaClass.isEnum()) {
// do nothing
Object value = JavaClassUtil.getEnumValue(javaClass, configBuilder, Boolean.TRUE);
Object value = JavaClassUtil.getEnumValue(javaClass, configBuilder);
String strVal = StringUtil.removeQuotes(String.valueOf(value));
FormData formData = new FormData();
formData.setKey(paramName);
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/com/ly/doc/template/JAXRSDocBuildTemplate.java
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ private ApiMethodReqParam requestParams(final DocJavaMethod docJavaMethod, Proje
}
JavaClass gicJavaClass = builder.getJavaProjectBuilder().getClassByName(gicName);
if (gicJavaClass.isEnum()) {
Object value = JavaClassUtil.getEnumValue(gicJavaClass, builder, Boolean.TRUE);
Object value = JavaClassUtil.getEnumValue(gicJavaClass, builder);
ApiParam param = ApiParam.of()
.setField(paramName)
.setDesc(comment + ",[array of enum]")
Expand Down Expand Up @@ -560,7 +560,7 @@ else if (JavaClassValidateUtil.isFile(typeName)) {
// param is enum
else if (javaClass.isEnum()) {
String o = JavaClassUtil.getEnumParams(javaClass);
Object value = JavaClassUtil.getEnumValue(javaClass, builder, true);
Object value = JavaClassUtil.getEnumValue(javaClass, builder);
ApiParam param = ApiParam.of()
.setField(paramName)
.setId(paramList.size() + 1)
Expand Down Expand Up @@ -664,7 +664,7 @@ private ApiRequestExample buildReqJson(DocJavaMethod javaMethod, ApiMethodDoc ap
|| JakartaJaxrsAnnotations.JAXB_REST_PATH_FULLY.equals(annotationName)
|| JAXRSAnnotations.JAX_PATH_PARAM_FULLY.equals(annotationName)) {
if (javaClass.isEnum()) {
Object value = JavaClassUtil.getEnumValue(javaClass, configBuilder, Boolean.TRUE);
Object value = JavaClassUtil.getEnumValue(javaClass, configBuilder);
mockValue = StringUtil.removeQuotes(String.valueOf(value));
}
pathParamsMap.put(paramName, mockValue);
Expand Down Expand Up @@ -715,7 +715,7 @@ else if (JavaClassValidateUtil.isArray(fullyQualifiedName)
}
else if (javaClass.isEnum()) {
// do nothing
Object value = JavaClassUtil.getEnumValue(javaClass, configBuilder, Boolean.TRUE);
Object value = JavaClassUtil.getEnumValue(javaClass, configBuilder);
String strVal = StringUtil.removeQuotes(String.valueOf(value));
FormData formData = new FormData();
formData.setDescription(comment);
Expand Down
Loading
Loading