test-version22
/
MeterSphere
mirror of https://gitee.com/fit2cloud-feizhiyun/MeterSphere.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix(接口测试): 解决swagger导入问题 

--user=郭雨琦
--bug=1013871
https://www.tapd.cn/55049933/bugtrace/bugs/view?bug_id=1155049933001013871
swagger导入有文件传不上来，有的文件导入后响应体展示的数据不对
This commit is contained in:
guoyuqi 2022-06-16 18:39:54 +08:00 committed by 刘瑞斌
parent d43be9bc35
commit 40609eb8f9
2 changed files with 52 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
backend/src/main/java/io/metersphere/api/dto/definition/parse/Swagger2Parser.java
View File

@ -24,7 +24,6 @@ import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.collections.MapUtils;
import org.apache.commons.lang3.StringUtils;
import java.io.InputStream;
import java.util.*;
@ -41,14 +40,14 @@ public class Swagger2Parser extends SwaggerAbstractParser {
try {
// 使用 url 导入 swagger
swagger = new SwaggerParser().read(request.getSwaggerUrl(), auths, true);
}catch (Exception e){
} catch (Exception e) {
LoggerUtil.error(e);
MSException.throwException("swagger验证失败");
}
} else {
sourceStr = getApiTestStr(source); // 导入的二进制文件转换为 String
swagger = new SwaggerParser().readWithInfo(sourceStr).getSwagger();
swagger = new SwaggerParser().readWithInfo(sourceStr, false).getSwagger();
}
if (swagger == null || swagger.getSwagger() == null) { // 不是 2.0 版本，则尝试转换 3.0
Swagger3Parser swagger3Parser = new Swagger3Parser();
@ -65,10 +64,10 @@ public class Swagger2Parser extends SwaggerAbstractParser {
private List<AuthorizationValue> setAuths(ApiTestImportRequest request) {
List<AuthorizationValue> auths = new ArrayList<>();
// 如果有 BaseAuth 参数，base64 编码后转换成 headers
if(request.getAuthManager() != null
if (request.getAuthManager() != null
&& StringUtils.isNotBlank(request.getAuthManager().getUsername())
&& StringUtils.isNotBlank(request.getAuthManager().getPassword())
&& request.getAuthManager().getVerification().equals("Basic Auth")){
&& request.getAuthManager().getVerification().equals("Basic Auth")) {
AuthorizationValue authorizationValue = new AuthorizationValue();
authorizationValue.setType("header");
authorizationValue.setKeyName("Authorization");
@ -78,10 +77,10 @@ public class Swagger2Parser extends SwaggerAbstractParser {
auths.add(authorizationValue);
}
// 设置 headers
if(!CollectionUtils.isEmpty(request.getHeaders())){
for(KeyValue keyValue : request.getHeaders()){
if (!CollectionUtils.isEmpty(request.getHeaders())) {
for (KeyValue keyValue : request.getHeaders()) {
// 当有 key 时才进行设置
if(StringUtils.isNotBlank(keyValue.getName())){
if (StringUtils.isNotBlank(keyValue.getName())) {
AuthorizationValue authorizationValue = new AuthorizationValue();
authorizationValue.setType("header");
authorizationValue.setKeyName(keyValue.getName());
@ -91,9 +90,9 @@ public class Swagger2Parser extends SwaggerAbstractParser {
}
}
// 设置 query 参数
if(!CollectionUtils.isEmpty(request.getArguments())){
for(KeyValue keyValue : request.getArguments()){
if(StringUtils.isNotBlank(keyValue.getName())){
if (!CollectionUtils.isEmpty(request.getArguments())) {
for (KeyValue keyValue : request.getArguments()) {
if (StringUtils.isNotBlank(keyValue.getName())) {
AuthorizationValue authorizationValue = new AuthorizationValue();
authorizationValue.setType("query");
authorizationValue.setKeyName(keyValue.getName());
@ -133,11 +132,11 @@ public class Swagger2Parser extends SwaggerAbstractParser {
for (HttpMethod method : httpMethods) {
Operation operation = operationMap.get(method);
MsHTTPSamplerProxy request = buildRequest(operation, pathName, method.name());
ApiDefinitionWithBLOBs apiDefinition = buildApiDefinition(request.getId(), operation, pathName, method.name(),importRequest);
ApiDefinitionWithBLOBs apiDefinition = buildApiDefinition(request.getId(), operation, pathName, method.name(), importRequest);
parseParameters(operation, request);
addBodyHeader(request);
if (StringUtils.isNotBlank(basePath)) {
String pathStr = (basePath + apiDefinition.getPath()).replaceAll("//","/");
String pathStr = (basePath + apiDefinition.getPath()).replaceAll("//", "/");
apiDefinition.setPath(pathStr);
request.setPath(pathStr);
}
@ -155,16 +154,16 @@ public class Swagger2Parser extends SwaggerAbstractParser {
return results;
}
private ApiDefinitionWithBLOBs buildApiDefinition(String id, Operation operation, String path, String method,ApiTestImportRequest importRequest) {
private ApiDefinitionWithBLOBs buildApiDefinition(String id, Operation operation, String path, String method, ApiTestImportRequest importRequest) {
String name = "";
if (StringUtils.isNotBlank(operation.getSummary())) {
name = operation.getSummary();
} else if (StringUtils.isNotBlank(operation.getOperationId())) {
} else if (StringUtils.isNotBlank(operation.getOperationId())) {
name = operation.getOperationId();
} else {
name = path;
}
return buildApiDefinition(id, name, path, method,importRequest);
return buildApiDefinition(id, name, path, method, importRequest);
}
private MsHTTPSamplerProxy buildRequest(Operation operation, String path, String method) {
@ -270,14 +269,14 @@ public class Swagger2Parser extends SwaggerAbstractParser {
responseCode = next.getKey();
response = next.getValue();
}
if (response!=null && responseCode!=null) {
if (response != null && responseCode != null) {
if (StringUtils.isNotBlank(response.getDescription())) {
msResponse.getStatusCode().add(new KeyValue(responseCode, response.getDescription()));
} else {
msResponse.getStatusCode().add(new KeyValue(responseCode, responseCode));
}
if (response.getResponseSchema()!=null) {
parseResponseBody(response.getResponseSchema(),msResponse.getBody());
if (response.getResponseSchema() != null) {
parseResponseBody(response.getResponseSchema(), msResponse.getBody());
msResponse.getBody().setFormat("JSON-SCHEMA");
String body = parseSchema(response.getResponseSchema());
if (StringUtils.isNotBlank(body)) {
@ -295,7 +294,7 @@ public class Swagger2Parser extends SwaggerAbstractParser {
return msResponse;
}
private void parseResponseBody(Model schema,Body body) {
private void parseResponseBody(Model schema, Body body) {
HashSet<String> refSet = new HashSet<>();
body.setJsonSchema(parseJsonSchema(schema, refSet));
}
@ -313,7 +312,7 @@ public class Swagger2Parser extends SwaggerAbstractParser {
item.setType("object");
ModelImpl model = (ModelImpl) schema;
item.setProperties(parseNewSchemaProperties(model, refSet));
if(model.getAdditionalProperties()!=null){
if (model.getAdditionalProperties() != null) {
item.setAdditionalProperties(parseProperty(model.getAdditionalProperties(), refSet));
}
} else if (schema instanceof AbstractModel) {
@ -324,7 +323,7 @@ public class Swagger2Parser extends SwaggerAbstractParser {
Model model = getRefModelType(schema, refSet);
item.setType("object");
item.setProperties(parseNewSchemaProperties(model, refSet));
}else {
} else {
return null;
}
@ -346,7 +345,7 @@ public class Swagger2Parser extends SwaggerAbstractParser {
}
private JsonSchemaItem parseProperty(Property property,HashSet<String> refSet){
private JsonSchemaItem parseProperty(Property property, HashSet<String> refSet) {
JsonSchemaItem item = new JsonSchemaItem();
item.setDescription(property.getDescription());
if (property instanceof ObjectProperty) {
@ -398,9 +397,9 @@ public class Swagger2Parser extends SwaggerAbstractParser {
HashSet<String> refSet = new HashSet<>();
Model model = getRefModelType(schema, refSet);
item.setType("object");
if (model != null){
if (model != null) {
item.setProperties(parseSchemaProperties(model.getProperties(), refSet));
if(((AbstractModel) model).getRequired()!=null){
if (((AbstractModel) model).getRequired() != null) {
item.setRequired(((AbstractModel) model).getRequired());
}
}
@ -412,22 +411,22 @@ public class Swagger2Parser extends SwaggerAbstractParser {
} else if (schema instanceof ModelImpl) {
ModelImpl model = (ModelImpl) schema;
item.setType("object");
if (model != null){
if (model != null) {
item.setProperties(parseSchemaProperties(model.getProperties(), new HashSet<>()));
if(model.getRequired()!=null){
if (model.getRequired() != null) {
item.setRequired(model.getRequired());
}
if(model.getAdditionalProperties()!=null){
if (model.getAdditionalProperties() != null) {
item.setAdditionalProperties(parseProperty(model.getAdditionalProperties(), new HashSet<>()));
}
}
}else if(schema instanceof AbstractModel){
} else if (schema instanceof AbstractModel) {
AbstractModel abstractModel = (AbstractModel) schema;
HashSet<String> refSet = new HashSet<>();
item.setType("object");
if (abstractModel != null)
item.setProperties(parseSchemaProperties(abstractModel.getProperties(), refSet));
if(abstractModel.getRequired()!=null){
if (abstractModel.getRequired() != null) {
item.setRequired(abstractModel.getRequired());
}
}
@ -501,7 +500,7 @@ public class Swagger2Parser extends SwaggerAbstractParser {
}
private void handleBaseProperties(JsonSchemaItem item, Property value) {
if (value instanceof StringProperty || value instanceof DateProperty || value instanceof DateTimeProperty ) {
if (value instanceof StringProperty || value instanceof DateProperty || value instanceof DateTimeProperty) {
item.setType("string");
} else if (value instanceof IntegerProperty || value instanceof BaseIntegerProperty) {
item.setType("integer");
@ -524,7 +523,7 @@ public class Swagger2Parser extends SwaggerAbstractParser {
Model model = this.definitions.get(simpleRef);
if (model != null) {
item.setProperties(parseSchemaProperties(model.getProperties(), refSet));
if(((AbstractModel) model).getRequired()!=null){
if (((AbstractModel) model).getRequired() != null) {
item.setRequired(((AbstractModel) model).getRequired());
}
}
@ -612,8 +611,7 @@ public class Swagger2Parser extends SwaggerAbstractParser {
propertyList.add(getBodyParameters(((ObjectProperty) items).getProperties(), refSet));
}
jsonObject.put(key, propertyList);
}
else {
} else {
jsonObject.put(key, new ArrayList<>());
}
} else if (value instanceof RefProperty) {

41
backend/src/main/java/io/metersphere/api/dto/definition/parse/Swagger3Parser.java
View File

@ -81,10 +81,10 @@ public class Swagger3Parser extends SwaggerAbstractParser {
private List<AuthorizationValue> setAuths(ApiTestImportRequest request) {
List<AuthorizationValue> auths = new ArrayList<>();
// 如果有 BaseAuth 参数，base64 编码后转换成 headers
if(request.getAuthManager() != null
if (request.getAuthManager() != null
&& StringUtils.isNotBlank(request.getAuthManager().getUsername())
&& StringUtils.isNotBlank(request.getAuthManager().getPassword())
&& request.getAuthManager().getVerification().equals("Basic Auth")){
&& request.getAuthManager().getVerification().equals("Basic Auth")) {
AuthorizationValue authorizationValue = new AuthorizationValue();
authorizationValue.setType("header");
authorizationValue.setKeyName("Authorization");
@ -94,10 +94,10 @@ public class Swagger3Parser extends SwaggerAbstractParser {
auths.add(authorizationValue);
}
// 设置 headers
if(!CollectionUtils.isEmpty(request.getHeaders())){
for(KeyValue keyValue : request.getHeaders()){
if (!CollectionUtils.isEmpty(request.getHeaders())) {
for (KeyValue keyValue : request.getHeaders()) {
// 当有 key 时才进行设置
if(StringUtils.isNotBlank(keyValue.getName())){
if (StringUtils.isNotBlank(keyValue.getName())) {
AuthorizationValue authorizationValue = new AuthorizationValue();
authorizationValue.setType("header");
authorizationValue.setKeyName(keyValue.getName());
@ -107,9 +107,9 @@ public class Swagger3Parser extends SwaggerAbstractParser {
}
}
// 设置 query 参数
if(!CollectionUtils.isEmpty(request.getArguments())){
for(KeyValue keyValue : request.getArguments()){
if(StringUtils.isNotBlank(keyValue.getName())){
if (!CollectionUtils.isEmpty(request.getArguments())) {
for (KeyValue keyValue : request.getArguments()) {
if (StringUtils.isNotBlank(keyValue.getName())) {
AuthorizationValue authorizationValue = new AuthorizationValue();
authorizationValue.setType("query");
authorizationValue.setKeyName(keyValue.getName());
@ -122,7 +122,6 @@ public class Swagger3Parser extends SwaggerAbstractParser {
}
private List<ApiDefinitionWithBLOBs> parseRequests(OpenAPI openAPI, ApiTestImportRequest importRequest) {
Paths paths = openAPI.getPaths();
@ -380,7 +379,7 @@ public class Swagger3Parser extends SwaggerAbstractParser {
Object propertiesResult = parseSchemaPropertiesToJson(schema, refSet, infoMap);
return propertiesResult == null ? getDefaultValueByPropertyType(schema) : propertiesResult;
} else {
return schema;
return getDefaultValueByPropertyType(schema);
}
}
@ -401,7 +400,7 @@ public class Swagger3Parser extends SwaggerAbstractParser {
parseKvBodyItem(schema, body, k, infoMap);
});
} else {
if(data instanceof Schema) {
if (data instanceof Schema) {
Schema dataSchema = (Schema) data;
if (StringUtils.isNotBlank(dataSchema.getName())) {
parseKvBodyItem(schema, body, dataSchema.getName(), infoMap);
@ -462,7 +461,7 @@ public class Swagger3Parser extends SwaggerAbstractParser {
private JsonSchemaItem parseSchema(Schema schema, Set<String> refSet) {
if (schema == null) return null;
JsonSchemaItem item = new JsonSchemaItem();
if(schema.getRequired()!=null){
if (schema.getRequired() != null) {
item.setRequired(schema.getRequired());
}
if (StringUtils.isNotBlank(schema.get$ref())) {
@ -470,7 +469,7 @@ public class Swagger3Parser extends SwaggerAbstractParser {
item.setType("object");
refSet.add(schema.get$ref());
Schema modelByRef = getModelByRef(schema.get$ref());
if (modelByRef != null){
if (modelByRef != null) {
item.setProperties(parseSchemaProperties(modelByRef, refSet));
item.setRequired(modelByRef.getRequired());
}
@ -495,7 +494,7 @@ public class Swagger3Parser extends SwaggerAbstractParser {
return null;
}
if (schema.getExample() != null) {
if (schema.getExample() != null) {
item.getMock().put("mock", schema.getExample());
} else {
item.getMock().put("mock", "");
@ -525,7 +524,7 @@ public class Swagger3Parser extends SwaggerAbstractParser {
return example == null ? 0 : example;
} else if (value instanceof NumberSchema) {
return example == null ? 0.0 : example;
} else if (value instanceof StringSchema) {
} else if (value instanceof StringSchema || value.getType().equals("string")) {
return example == null ? "" : example;
} else {// todo 其他类型?
return getDefaultStringValue(value.getDescription());
@ -603,13 +602,13 @@ public class Swagger3Parser extends SwaggerAbstractParser {
JSONObject requestBody = buildRequestBody(requestObject);
swaggerApiInfo.setRequestBody(requestBody);
// 设置响应体
JSONObject responseObject = JSON.parseObject(apiDefinition.getResponse(),Feature.DisableSpecialKeyDetect);
JSONObject responseObject = JSON.parseObject(apiDefinition.getResponse(), Feature.DisableSpecialKeyDetect);
swaggerApiInfo.setResponses(buildResponseBody(responseObject));
// 设置请求参数列表
List<JSONObject> paramsList = buildParameters(requestObject);
swaggerApiInfo.setParameters(paramsList);
swaggerApiInfo.setDescription(apiDefinition.getDescription());
JSONObject methodDetail = JSON.parseObject(JSON.toJSONString(swaggerApiInfo),Feature.DisableSpecialKeyDetect);
JSONObject methodDetail = JSON.parseObject(JSON.toJSONString(swaggerApiInfo), Feature.DisableSpecialKeyDetect);
if (paths.getJSONObject(apiDefinition.getPath()) == null) {
paths.put(apiDefinition.getPath(), new JSONObject());
} // 一个路径下有多个发方法，如post，get，因此是一个 JSONObject 类型
@ -649,7 +648,7 @@ public class Swagger3Parser extends SwaggerAbstractParser {
// schema.put("example", param.getString("value"));
// swaggerParam.setSchema(schema);
// }
paramsList.add(JSON.parseObject(JSON.toJSONString(swaggerParam),Feature.DisableSpecialKeyDetect));
paramsList.add(JSON.parseObject(JSON.toJSONString(swaggerParam), Feature.DisableSpecialKeyDetect));
}
}
}
@ -725,8 +724,8 @@ public class Swagger3Parser extends SwaggerAbstractParser {
String type = requestBody.getString("type");
JSONObject parsedParam = new JSONObject();
if(required!=null){
parsedParam.put("required",required);
if (required != null) {
parsedParam.put("required", required);
}
if (StringUtils.isNotBlank(type)) {
if (StringUtils.equals(type, "array")) {
@ -844,7 +843,7 @@ public class Swagger3Parser extends SwaggerAbstractParser {
property.put("required", obj.getString("required"));
if (obj.getJSONObject("properties") != null) {
JSONObject properties1 = buildFormDataSchema(obj.getJSONObject("properties"));
property.put("properties",properties1.getJSONObject("properties"));
property.put("properties", properties1.getJSONObject("properties"));
}
properties.put(key, property);
}