mirror of
https://github.com/wiremock/WireMock.Net.git
synced 2026-04-29 19:57:09 +02:00
Create WireMock.Net.MimePart project (#1300)
* Create WireMock.Net.MimePart project * . * REFACTOR * ILRepack * -- * ... * x * x * . * fix * public class MimePartMatcher * shared * min * . * <!--<DelaySign>true</DelaySign>--> * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Stef Heyenrath
329
src/WireMock.Net.Minimal/Serialization/SwaggerMapper.cs
Normal file
329
src/WireMock.Net.Minimal/Serialization/SwaggerMapper.cs
Normal file
@@ -0,0 +1,329 @@
|
||||
// Copyright © WireMock.Net
|
||||
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using Newtonsoft.Json;
|
||||
using NJsonSchema;
|
||||
using NJsonSchema.Extensions;
|
||||
using NSwag;
|
||||
using WireMock.Admin.Mappings;
|
||||
using WireMock.Constants;
|
||||
using WireMock.Extensions;
|
||||
using WireMock.Matchers;
|
||||
using WireMock.Server;
|
||||
using WireMock.Util;
|
||||
|
||||
namespace WireMock.Serialization;
|
||||
|
||||
internal static class SwaggerMapper
|
||||
{
|
||||
private const string DefaultMethod = "GET";
|
||||
private const string Generator = "WireMock.Net";
|
||||
|
||||
private static readonly JsonSchema JsonSchemaString = new() { Type = JsonObjectType.String };
|
||||
|
||||
public static string ToSwagger(WireMockServer server)
|
||||
{
|
||||
var openApiDocument = new OpenApiDocument
|
||||
{
|
||||
Generator = Generator,
|
||||
Info = new OpenApiInfo
|
||||
{
|
||||
Title = $"{Generator} Mappings Swagger specification",
|
||||
Version = SystemUtils.Version
|
||||
},
|
||||
};
|
||||
|
||||
foreach (var url in server.Urls)
|
||||
{
|
||||
openApiDocument.Servers.Add(new OpenApiServer
|
||||
{
|
||||
Url = url
|
||||
});
|
||||
}
|
||||
|
||||
foreach (var mapping in server.MappingModels)
|
||||
{
|
||||
var path = mapping.Request.GetPathAsString();
|
||||
if (path == null)
|
||||
{
|
||||
// Path is null (probably a Func<>), skip this.
|
||||
continue;
|
||||
}
|
||||
|
||||
var operation = new OpenApiOperation();
|
||||
foreach (var openApiParameter in MapRequestQueryParameters(mapping.Request.Params))
|
||||
{
|
||||
operation.Parameters.Add(openApiParameter);
|
||||
}
|
||||
|
||||
foreach (var openApiParameter in MapRequestHeaders(mapping.Request.Headers))
|
||||
{
|
||||
operation.Parameters.Add(openApiParameter);
|
||||
}
|
||||
|
||||
foreach (var openApiParameter in MapRequestCookies(mapping.Request.Cookies))
|
||||
{
|
||||
operation.Parameters.Add(openApiParameter);
|
||||
}
|
||||
|
||||
operation.RequestBody = MapRequestBody(mapping.Request);
|
||||
|
||||
var response = MapResponse(mapping.Response);
|
||||
if (response != null)
|
||||
{
|
||||
operation.Responses.Add(mapping.Response.GetStatusCodeAsString(), response);
|
||||
}
|
||||
|
||||
var method = mapping.Request.Methods?.FirstOrDefault() ?? DefaultMethod;
|
||||
if (!openApiDocument.Paths.ContainsKey(path))
|
||||
{
|
||||
var openApiPathItem = new OpenApiPathItem
|
||||
{
|
||||
{ method, operation }
|
||||
};
|
||||
|
||||
openApiDocument.Paths.Add(path, openApiPathItem);
|
||||
}
|
||||
else
|
||||
{
|
||||
// The combination of path+method uniquely identify an operation. Duplicates are not allowed.
|
||||
if (!openApiDocument.Paths[path].ContainsKey(method))
|
||||
{
|
||||
openApiDocument.Paths[path].Add(method, operation);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return openApiDocument.ToJson(SchemaType.OpenApi3, Formatting.Indented);
|
||||
}
|
||||
|
||||
private static IReadOnlyList<OpenApiParameter> MapRequestQueryParameters(IList<ParamModel>? queryParameters)
|
||||
{
|
||||
if (queryParameters == null)
|
||||
{
|
||||
return new List<OpenApiParameter>();
|
||||
}
|
||||
|
||||
return queryParameters
|
||||
.Where(x => x.Matchers != null && x.Matchers.Any())
|
||||
.Select(x => new
|
||||
{
|
||||
x.Name,
|
||||
Details = GetDetailsFromMatcher(x.Matchers![0])
|
||||
})
|
||||
.Select(x => new OpenApiParameter
|
||||
{
|
||||
Name = x.Name,
|
||||
Example = x.Details.Example,
|
||||
Description = x.Details.Description,
|
||||
Kind = OpenApiParameterKind.Query,
|
||||
Schema = x.Details.JsonSchemaRegex,
|
||||
IsRequired = !x.Details.Reject
|
||||
})
|
||||
.ToList();
|
||||
}
|
||||
|
||||
private static IEnumerable<OpenApiParameter> MapRequestHeaders(IList<HeaderModel>? headers)
|
||||
{
|
||||
if (headers == null)
|
||||
{
|
||||
return new List<OpenApiHeader>();
|
||||
}
|
||||
|
||||
return headers
|
||||
.Where(x => x.Matchers != null && x.Matchers.Any())
|
||||
.Select(x => new
|
||||
{
|
||||
x.Name,
|
||||
Details = GetDetailsFromMatcher(x.Matchers![0])
|
||||
})
|
||||
.Select(x => new OpenApiHeader
|
||||
{
|
||||
Name = x.Name,
|
||||
Example = x.Details.Example,
|
||||
Description = x.Details.Description,
|
||||
Kind = OpenApiParameterKind.Header,
|
||||
Schema = x.Details.JsonSchemaRegex,
|
||||
IsRequired = !x.Details.Reject
|
||||
})
|
||||
.ToList();
|
||||
}
|
||||
|
||||
private static IReadOnlyList<OpenApiParameter> MapRequestCookies(IList<CookieModel>? cookies)
|
||||
{
|
||||
if (cookies == null)
|
||||
{
|
||||
return new List<OpenApiParameter>();
|
||||
}
|
||||
|
||||
return cookies
|
||||
.Where(x => x.Matchers != null && x.Matchers.Any())
|
||||
.Select(x => new
|
||||
{
|
||||
x.Name,
|
||||
Details = GetDetailsFromMatcher(x.Matchers![0])
|
||||
})
|
||||
.Select(x => new OpenApiParameter
|
||||
{
|
||||
Name = x.Name,
|
||||
Example = x.Details.Example,
|
||||
Description = x.Details.Description,
|
||||
Kind = OpenApiParameterKind.Cookie,
|
||||
Schema = x.Details.JsonSchemaRegex,
|
||||
IsRequired = !x.Details.Reject
|
||||
})
|
||||
.ToList();
|
||||
}
|
||||
|
||||
private static (JsonSchema JsonSchemaRegex, string? Example, string? Description, bool Reject) GetDetailsFromMatcher(MatcherModel matcher)
|
||||
{
|
||||
var pattern = GetPatternAsStringFromMatcher(matcher);
|
||||
var reject = matcher.RejectOnMatch == true;
|
||||
var description = $"{matcher.Name} with RejectOnMatch = '{reject}' and Pattern = '{pattern}'";
|
||||
|
||||
return matcher.Name is nameof(RegexMatcher) ?
|
||||
(new JsonSchema { Type = JsonObjectType.String, Format = "regex", Pattern = pattern }, pattern, description, reject) :
|
||||
(JsonSchemaString, pattern, description, reject);
|
||||
}
|
||||
|
||||
private static OpenApiRequestBody? MapRequestBody(RequestModel request)
|
||||
{
|
||||
var body = MapRequestBody(request.Body);
|
||||
if (body == null)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
var openApiMediaType = new OpenApiMediaType
|
||||
{
|
||||
Schema = GetJsonSchema(body)
|
||||
};
|
||||
|
||||
var requestBodyPost = new OpenApiRequestBody();
|
||||
requestBodyPost.Content.Add(GetContentType(request), openApiMediaType);
|
||||
|
||||
return requestBodyPost;
|
||||
}
|
||||
|
||||
private static OpenApiResponse? MapResponse(ResponseModel response)
|
||||
{
|
||||
if (response.Body != null)
|
||||
{
|
||||
return new OpenApiResponse
|
||||
{
|
||||
Schema = new JsonSchemaProperty
|
||||
{
|
||||
Type = JsonObjectType.String,
|
||||
Example = response.Body
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
if (response.BodyAsBytes != null)
|
||||
{
|
||||
// https://stackoverflow.com/questions/62794949/how-to-define-byte-array-in-openapi-3-0
|
||||
return new OpenApiResponse
|
||||
{
|
||||
Schema = new JsonSchemaProperty
|
||||
{
|
||||
Type = JsonObjectType.Array,
|
||||
Items =
|
||||
{
|
||||
new JsonSchema
|
||||
{
|
||||
Type = JsonObjectType.String,
|
||||
Format = JsonFormatStrings.Byte
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
if (response.BodyAsJson == null)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
return new OpenApiResponse
|
||||
{
|
||||
Schema = GetJsonSchema(response.BodyAsJson)
|
||||
};
|
||||
}
|
||||
|
||||
private static JsonSchema GetJsonSchema(object instance)
|
||||
{
|
||||
switch (instance)
|
||||
{
|
||||
case string instanceAsString:
|
||||
try
|
||||
{
|
||||
var value = JsonConvert.DeserializeObject(instanceAsString);
|
||||
return GetJsonSchema(value!);
|
||||
}
|
||||
catch
|
||||
{
|
||||
return JsonSchemaString;
|
||||
}
|
||||
|
||||
default:
|
||||
return instance.ToJsonSchema();
|
||||
}
|
||||
}
|
||||
|
||||
private static object? MapRequestBody(BodyModel? body)
|
||||
{
|
||||
if (body == null)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
var matcher = GetMatcher(body.Matcher, body.Matchers);
|
||||
if (matcher is { Name: nameof(JsonMatcher) })
|
||||
{
|
||||
var pattern = GetPatternAsStringFromMatcher(matcher);
|
||||
if (JsonUtils.TryParseAsJObject(pattern, out var jObject))
|
||||
{
|
||||
return jObject;
|
||||
}
|
||||
|
||||
return pattern;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private static string GetContentType(RequestModel request)
|
||||
{
|
||||
var contentType = request.Headers?.FirstOrDefault(h => h.Name == "Content-Type");
|
||||
|
||||
return contentType == null ?
|
||||
WireMockConstants.ContentTypeJson :
|
||||
GetPatternAsStringFromMatchers(contentType.Matchers, WireMockConstants.ContentTypeJson);
|
||||
}
|
||||
|
||||
private static string GetPatternAsStringFromMatchers(IList<MatcherModel>? matchers, string defaultValue)
|
||||
{
|
||||
if (matchers == null || !matchers.Any())
|
||||
{
|
||||
return defaultValue;
|
||||
}
|
||||
|
||||
return GetPatternAsStringFromMatcher(matchers.First()) ?? defaultValue;
|
||||
}
|
||||
|
||||
private static string? GetPatternAsStringFromMatcher(MatcherModel matcher)
|
||||
{
|
||||
if (matcher.Pattern is string patternAsString)
|
||||
{
|
||||
return patternAsString;
|
||||
}
|
||||
|
||||
return matcher.Patterns?.FirstOrDefault() as string;
|
||||
}
|
||||
|
||||
private static MatcherModel? GetMatcher(MatcherModel? matcher, MatcherModel[]? matchers)
|
||||
{
|
||||
return matcher ?? matchers?.FirstOrDefault();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user