All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.binfast.adpter.openapi.utils.TornaUtil Maven / Gradle / Ivy
package com.binfast.adpter.openapi.utils;
import com.google.gson.Gson;
import com.google.gson.JsonElement;
import com.google.gson.JsonParser;
import com.power.common.model.EnumDictionary;
import com.power.common.util.CollectionUtil;
import com.power.common.util.OkHttp3Util;
import com.power.common.util.StringUtil;
import com.binfast.adpter.openapi.constants.DocGlobalConstants;
import com.binfast.adpter.openapi.constants.TornaConstants;
import com.binfast.adpter.openapi.model.*;
import com.binfast.adpter.openapi.model.rpc.RpcApiDependency;
import com.binfast.adpter.openapi.model.torna.*;
import com.thoughtworks.qdox.JavaProjectBuilder;
import org.apache.commons.lang3.StringUtils;
import java.util.*;
import static com.binfast.adpter.openapi.constants.DocGlobalConstants.ARRAY;
import static com.binfast.adpter.openapi.constants.DocGlobalConstants.OBJECT;
import static com.binfast.adpter.openapi.constants.TornaConstants.ENUM_PUSH;
import static com.binfast.adpter.openapi.constants.TornaConstants.PUSH;
/**
* @author xingzi 2021/4/28 16:15
**/
public class TornaUtil {
public static void pushToTorna(TornaApi tornaApi, ApiConfig apiConfig, JavaProjectBuilder builder) {
//Build push document information
Map requestJson = TornaConstants.buildParams(PUSH, new Gson().toJson(tornaApi), apiConfig);
//Push dictionary information
Map dicMap = new HashMap<>(2);
List docDicts = TornaUtil.buildTornaDic(DocUtil.buildDictionary(apiConfig, builder));
if (CollectionUtil.isNotEmpty(docDicts)) {
dicMap.put("enums", docDicts);
Map dicRequestJson = TornaConstants.buildParams(ENUM_PUSH, new Gson().toJson(dicMap), apiConfig);
String dicResponseMsg = OkHttp3Util.syncPostJson(apiConfig.getOpenUrl(), new Gson().toJson(dicRequestJson));
TornaUtil.printDebugInfo(apiConfig, dicResponseMsg, dicRequestJson, ENUM_PUSH);
}
//Get the response result
String responseMsg = OkHttp3Util.syncPostJson(apiConfig.getOpenUrl(), new Gson().toJson(requestJson));
//Print the log of pushing documents to Torna
TornaUtil.printDebugInfo(apiConfig, responseMsg, requestJson, PUSH);
}
public static boolean setDebugEnv(ApiConfig apiConfig, TornaApi tornaApi) {
boolean hasDebugEnv = StringUtils.isNotBlank(apiConfig.getDebugEnvName())
&&
StringUtils.isNotBlank(apiConfig.getDebugEnvUrl());
//Set up the test environment
List debugEnvs = new ArrayList<>();
if (hasDebugEnv) {
DebugEnv debugEnv = new DebugEnv();
debugEnv.setName(apiConfig.getDebugEnvName());
debugEnv.setUrl(apiConfig.getDebugEnvUrl());
debugEnvs.add(debugEnv);
}
tornaApi.setDebugEnvs(debugEnvs);
return hasDebugEnv;
}
public static void printDebugInfo(ApiConfig apiConfig, String responseMsg, Map requestJson, String category) {
if (apiConfig.isTornaDebug()) {
String sb = "Configuration information : \n" +
"OpenUrl: " +
apiConfig.getOpenUrl() +
"\n" +
"appToken: " +
apiConfig.getAppToken() +
"\n";
System.out.println(sb);
try {
JsonElement element = JsonParser.parseString(responseMsg);
TornaRequestInfo info = new TornaRequestInfo()
.of()
.setCategory(category)
.setCode(element.getAsJsonObject().get(TornaConstants.CODE).getAsString())
.setMessage(element.getAsJsonObject().get(TornaConstants.MESSAGE).getAsString())
.setRequestInfo(requestJson)
.setResponseInfo(responseMsg);
System.out.println(info.buildInfo());
} catch (Exception e) {
//Ex : Nginx Error,Tomcat Error
System.out.println("Response Error : \n" + responseMsg);
}
}
}
/**
* build apis
*
* @param apiMethodDocs apiMethodDocs
* @param hasDebugEnv has debug environment
* @return List of Api
*/
public static List buildApis(List apiMethodDocs, boolean hasDebugEnv) {
//Parameter list
List apis = new ArrayList<>();
Apis methodApi;
//Iterative classification interface
for (ApiMethodDoc apiMethodDoc : apiMethodDocs) {
methodApi = new Apis();
methodApi.setIsFolder(TornaConstants.NO);
methodApi.setName(apiMethodDoc.getDesc());
methodApi.setUrl(hasDebugEnv ? subFirstUrlOrPath(apiMethodDoc.getPath()) : subFirstUrlOrPath(apiMethodDoc.getUrl()));
methodApi.setHttpMethod(apiMethodDoc.getType());
methodApi.setContentType(apiMethodDoc.getContentType());
methodApi.setDescription(apiMethodDoc.getDetail());
methodApi.setIsShow(TornaConstants.YES);
methodApi.setAuthor(apiMethodDoc.getAuthor());
methodApi.setOrderIndex(apiMethodDoc.getOrder());
methodApi.setHeaderParams(buildHerder(apiMethodDoc.getRequestHeaders()));
methodApi.setResponseParams(buildParams(apiMethodDoc.getResponseParams()));
methodApi.setIsRequestArray(apiMethodDoc.getIsRequestArray());
methodApi.setIsResponseArray(apiMethodDoc.getIsResponseArray());
methodApi.setRequestArrayType(apiMethodDoc.getRequestArrayType());
methodApi.setResponseArrayType(apiMethodDoc.getResponseArrayType());
methodApi.setDeprecated(apiMethodDoc.isDeprecated() ? "Deprecated" : null);
//Path
if (CollectionUtil.isNotEmpty(apiMethodDoc.getPathParams())) {
methodApi.setPathParams(buildParams(apiMethodDoc.getPathParams()));
}
if (CollectionUtil.isNotEmpty(apiMethodDoc.getQueryParams())
&& DocGlobalConstants.FILE_CONTENT_TYPE.equals(apiMethodDoc.getContentType())) {
// file upload
methodApi.setRequestParams(buildParams(apiMethodDoc.getQueryParams()));
} else if (CollectionUtil.isNotEmpty(apiMethodDoc.getQueryParams())) {
methodApi.setQueryParams(buildParams(apiMethodDoc.getQueryParams()));
}
//Json
if (CollectionUtil.isNotEmpty(apiMethodDoc.getRequestParams())) {
methodApi.setRequestParams(buildParams(apiMethodDoc.getRequestParams()));
}
apis.add(methodApi);
}
return apis;
}
/**
* build apis
*
* @param apiMethodDocs apiMethodDocs
* @return List of Api
*/
public static List buildDubboApis(List apiMethodDocs) {
//Parameter list
List apis = new ArrayList<>();
Apis methodApi;
//Iterative classification interface
for (RpcJavaMethod apiMethodDoc : apiMethodDocs) {
methodApi = new Apis();
methodApi.setIsFolder(TornaConstants.NO);
methodApi.setName(apiMethodDoc.getDesc());
methodApi.setDescription(apiMethodDoc.getDetail());
methodApi.setIsShow(TornaConstants.YES);
methodApi.setAuthor(apiMethodDoc.getAuthor());
methodApi.setUrl(apiMethodDoc.getMethodDefinition());
methodApi.setResponseParams(buildParams(apiMethodDoc.getResponseParams()));
methodApi.setOrderIndex(apiMethodDoc.getOrder());
methodApi.setDeprecated(apiMethodDoc.isDeprecated() ? "Deprecated" : null);
//Json
if (CollectionUtil.isNotEmpty(apiMethodDoc.getRequestParams())) {
methodApi.setRequestParams(buildParams(apiMethodDoc.getRequestParams()));
}
apis.add(methodApi);
}
return apis;
}
/**
* build request header
*
* @param apiReqParams Request header parameter list
* @return List of HttpParam
*/
public static List buildHerder(List apiReqParams) {
HttpParam httpParam;
List headers = new ArrayList<>();
for (ApiReqParam header : apiReqParams) {
httpParam = new HttpParam();
httpParam.setName(header.getName());
httpParam.setRequired(header.isRequired() ? TornaConstants.YES : TornaConstants.NO);
httpParam.setExample(StringUtil.removeQuotes(header.getValue()));
if (StringUtil.isNotEmpty(header.getSince()) && !DocGlobalConstants.DEFAULT_VERSION.equals(header.getSince())) {
httpParam.setDescription(header.getDesc() + "@since " + header.getSince());
} else {
httpParam.setDescription(header.getDesc());
}
headers.add(httpParam);
}
return headers;
}
/**
* build request response params
*
* @param apiParams Param list
* @return List of HttpParam
*/
public static List buildParams(List apiParams) {
HttpParam httpParam;
List bodies = new ArrayList<>();
for (ApiParam apiParam : apiParams) {
httpParam = new HttpParam();
httpParam.setName(apiParam.getField());
httpParam.setOrderIndex(apiParam.getId());
httpParam.setMaxLength(apiParam.getMaxLength());
String type = apiParam.getType();
if (Objects.equals(type, DocGlobalConstants.PARAM_TYPE_FILE) && apiParam.isHasItems()) {
type = TornaConstants.PARAM_TYPE_FILE_ARRAY;
}
httpParam.setType(type);
httpParam.setRequired(apiParam.isRequired() ? TornaConstants.YES : TornaConstants.NO);
httpParam.setExample(StringUtil.removeQuotes(apiParam.getValue()));
if (StringUtil.isNotEmpty(apiParam.getVersion()) && !DocGlobalConstants.DEFAULT_VERSION.equals(apiParam.getVersion())) {
httpParam.setDescription(DocUtil.replaceNewLineToHtmlBr(apiParam.getDesc()) + "@since " + apiParam.getVersion());
} else {
httpParam.setDescription(DocUtil.replaceNewLineToHtmlBr(apiParam.getDesc()));
}
httpParam.setEnumInfo(apiParam.getEnumInfo());
if (apiParam.getChildren() != null) {
httpParam.setChildren(buildParams(apiParam.getChildren()));
}
bodies.add(httpParam);
}
return bodies;
}
public static String buildDependencies(List dependencies) {
StringBuilder s = new StringBuilder();
if (CollectionUtil.isNotEmpty(dependencies)) {
for (RpcApiDependency r : dependencies) {
s.append(r.toString()).append("\n\n");
}
}
return s.toString();
}
public static List buildErrorCode(ApiConfig config, JavaProjectBuilder javaProjectBuilder) {
List commonErrorCodes = new ArrayList<>();
CommonErrorCode commonErrorCode;
List errorCodes = DocUtil.errorCodeDictToList(config, javaProjectBuilder);
if (CollectionUtil.isNotEmpty(errorCodes)) {
for (EnumDictionary code : errorCodes) {
commonErrorCode = new CommonErrorCode();
commonErrorCode.setCode(code.getValue());
// commonErrorCode.setSolution(code.getDesc());
commonErrorCode.setMsg(DocUtil.replaceNewLineToHtmlBr(code.getDesc()));
commonErrorCodes.add(commonErrorCode);
}
}
return commonErrorCodes;
}
public static List buildTornaDic(List apiDocDicts) {
List dics = new ArrayList<>();
TornaDic tornaDic;
if (CollectionUtil.isNotEmpty(apiDocDicts)) {
for (ApiDocDict doc : apiDocDicts) {
tornaDic = new TornaDic();
tornaDic.setName(doc.getTitle())
.setDescription(DocUtil.replaceNewLineToHtmlBr(doc.getDescription()))
.setItems(buildTornaDicItems(doc.getDataDictList()));
dics.add(tornaDic);
}
}
return dics;
}
private static List buildTornaDicItems(List dataDicts) {
List apis = new ArrayList<>();
HttpParam api;
if (CollectionUtil.isNotEmpty(dataDicts)) {
for (EnumDictionary d : dataDicts) {
api = new HttpParam();
api.setName(d.getName());
api.setType(d.getType());
api.setValue(d.getValue());
api.setDescription(d.getDesc());
apis.add(api);
}
}
return apis;
}
/**
* 设置请求参数是否为数组
*
* @param apiMethodDoc 请求参数
*/
public static void setTornaArrayTags(ApiMethodDoc apiMethodDoc) {
List reqList = apiMethodDoc.getRequestParams();
List repList = apiMethodDoc.getResponseParams();
apiMethodDoc.setIsRequestArray(0);
apiMethodDoc.setIsResponseArray(0);
//response
if (CollectionUtil.isNotEmpty(repList)) {
ApiParam apiParam = repList.get(0);
boolean isReqList = repList.size() == 1 && ARRAY.equals(apiParam.getType());
String className = getType(apiParam.getClassName());
apiMethodDoc.setResponseArrayType(JavaClassValidateUtil.isPrimitive(className) ? className : OBJECT);
apiMethodDoc.setIsResponseArray(isReqList ? 1 : 0);
}
//request
if (CollectionUtil.isNotEmpty(repList)) {
ApiParam apiParam = repList.get(0);
boolean isRepList = reqList.size() == 1 && ARRAY.equals(apiParam.getType());
String className = getType(apiParam.getClassName());
apiMethodDoc.setRequestArrayType(JavaClassValidateUtil.isPrimitive(className) ? className : OBJECT);
apiMethodDoc.setIsRequestArray(isRepList ? 1 : 0);
}
}
private static String getType(String typeName) {
String gicType;
//get generic type
if (typeName.contains("<")) {
gicType = typeName.substring(typeName.indexOf("<") + 1, typeName.lastIndexOf(">"));
} else {
gicType = typeName;
}
if (gicType.contains("[")) {
gicType = gicType.substring(0, gicType.indexOf("["));
}
return gicType.substring(gicType.lastIndexOf(".") + 1).toLowerCase();
}
private static String subFirstUrlOrPath(String url) {
if (StringUtil.isEmpty(url)) {
return StringUtil.EMPTY;
}
if (!url.contains(DocGlobalConstants.MULTI_URL_SEPARATOR)) {
return url;
}
String[] split = StringUtil.split(url, DocGlobalConstants.MULTI_URL_SEPARATOR);
return split[0];
}
}
