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
26 changes: 16 additions & 10 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -125,16 +125,22 @@
</executions>
</plugin>
<!-- JavaDoc -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven-javadoc-plugin.version}</version>
<configuration>
<!--
Fail the build if any Javadoc warnings or errors occur.
This ensures that all Javadoc issues are treated seriously.
-->
<failOnError>true</failOnError>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven-javadoc-plugin.version}</version>
<configuration>
<!--
Fail the build immediately if any Javadoc error is encountered.
Ensures critical issues like syntax errors or broken HTML are not ignored.
-->
<failOnError>true</failOnError>
<!--
Fail the build if any Javadoc warning occurs (e.g., missing @param, @return).
Combined with -Xdoclint:all, this enforces strict documentation discipline.
Note: Requires maven-javadoc-plugin version 3.0.0 or higher.
-->
<failOnWarnings>true</failOnWarnings>
<additionalOptions>
<!--
Enable strict validation of Javadoc content.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@ abstract Map<String, Object> buildPathUrlsRequest(ApiConfig apiConfig, ApiMethod
* @param apiConfig Configuration of smart-doc
* @param apiSchema Project API schema
* @param tags tags
* @param isSwagger is swagger
* @return Map of paths
*/
@SuppressWarnings("unchecked")
Expand Down Expand Up @@ -490,7 +491,8 @@ public Map<String, Object> buildProperties(List<ApiParam> apiParam, Map<String,
if (param.isRequired()) {
requiredList.add(param.getField());
}
if (param.getType().equals("map") && StringUtil.isEmpty(param.getClassName())) {
if (ParamTypeConstants.PARAM_TYPE_MAP.equals(param.getType())
&& StringUtil.isEmpty(param.getClassName())) {
continue;
}
if (param.isQueryParam() || param.isPathParam()) {
Expand Down Expand Up @@ -665,37 +667,42 @@ protected Object getExampleValueBasedOnTypeForApiReqParam(ApiReqParam apiReqPara
return getValueByType(apiReqParam.getValue(), apiReqParam.getType());
}

/**
* Get value by type
* @param originalValue original value
* @param type type
* @return value
*/
private Object getValueByType(String originalValue, String type) {
if (StringUtil.isEmpty(originalValue) || StringUtil.isEmpty(type)) {
return originalValue;
}
try {
String openApiType = DocUtil.javaTypeToOpenApiTypeConvert(type);
if ("boolean".equals(openApiType)) {
return Boolean.parseBoolean(originalValue);
}
else if ("integer".equals(openApiType)) {
return Integer.parseInt(originalValue);
}
else if ("number".equals(openApiType)) {
String javaTypeName = type.toLowerCase();
switch (javaTypeName) {
case "long":
case "java.lang.long":
case "int64":
return Long.parseLong(originalValue);
case "double":
case "java.lang.double":
return Double.parseDouble(originalValue);
case "float":
case "java.lang.float":
return Float.parseFloat(originalValue);
case "java.math.biginteger":
return new BigInteger(originalValue);
case "java.math.bigdecimal":
return new BigDecimal(originalValue);
}
return originalValue;
switch (openApiType) {
case "boolean":
return Boolean.parseBoolean(originalValue);
case "integer":
return Integer.parseInt(originalValue);
case "number":
String javaTypeName = type.toLowerCase();
switch (javaTypeName) {
case "long":
case "java.lang.long":
case "int64":
return Long.parseLong(originalValue);
case "double":
case "java.lang.double":
return Double.parseDouble(originalValue);
case "float":
case "java.lang.float":
return Float.parseFloat(originalValue);
case "java.math.biginteger":
return new BigInteger(originalValue);
case "java.math.bigdecimal":
return new BigDecimal(originalValue);
}
return originalValue;
}
return originalValue;
}
Expand Down
Loading