private RestEaseParameter BuildValidParameter(string identifier, OpenApiSchema schema, bool required, string description, ParameterLocation? parameterLocation, params string[] extraAttributes)
{
var attributes = new List<string>();
string validIdentifier = CSharpUtils.CreateValidIdentifier(identifier, CasingType.Camel);
string restEaseParameterAnnotation = parameterLocation != null ? parameterLocation.ToString() : string.Empty;
string isNullPostfix = !required && Settings.MakeNonRequiredParametersOptional ? " = null" : string.Empty;
if (parameterLocation == ParameterLocation.Header)
{
attributes.Add($"\"{identifier}\"");
}
object identifierWithType;
if (identifier != validIdentifier)
{
switch (parameterLocation)
{
case ParameterLocation.Path:
case ParameterLocation.Query:
attributes.Add($"Name = \"{identifier}\"");
break;
}
attributes.AddRange(extraAttributes);
identifierWithType = MapSchema(schema, validIdentifier, !required, false, null);
return new RestEaseParameter
{
Required = required,
Identifier = validIdentifier,
SchemaType = schema.GetSchemaType(),
SchemaFormat = schema.GetSchemaFormat(),
IdentifierWithType = $"{identifierWithType}",
IdentifierWithRestEase = $"[{restEaseParameterAnnotation}({string.Join(", ", attributes)})] {identifierWithType}{isNullPostfix}",
Summary = description
};
}
string extraAttributesBetweenParentheses = extraAttributes.Length == 0 ? string.Empty : $"({string.Join(", ", extraAttributes)})";
identifierWithType = MapSchema(schema, identifier, !required, false, null);
return new RestEaseParameter
{
Required = required,
Identifier = identifier,
SchemaType = schema.GetSchemaType(),
SchemaFormat = schema.GetSchemaFormat(),
IdentifierWithType = $"{identifierWithType}",
IdentifierWithRestEase = $"[{restEaseParameterAnnotation}{extraAttributesBetweenParentheses}] {identifierWithType}{isNullPostfix}",
Summary = description
};
}
private object MapPropertyAsJObject(OpenApiSchema openApiSchema, string key)
{
if (openApiSchema.GetSchemaType() == SchemaType.Object || openApiSchema.GetSchemaType() == SchemaType.Array)
{
var mapped = MapSchemaToObject(openApiSchema, key);
if (mapped is JProperty jp)
{
return(jp);
}
else
{
return(new JProperty(key, mapped));
}
}
else
{
bool propertyIsNullable = openApiSchema.Nullable || (openApiSchema.TryGetXNullable(out bool x) && x);
return(new JProperty(key, _exampleValueGenerator.GetExampleValue(openApiSchema)));
}
}
private static string Type(OpenApiSchema schema)
{
var result = "object";
if (schema.GetSchemaType() == SchemaTypeEnum.ArraySchema)
{
result = "array";
}
else if (schema.Type != null)
{
result = schema.Type;
}
return(result);
}
public object GetExampleValue(OpenApiSchema schema)
{
switch (schema?.GetSchemaType())
{
case SchemaType.Boolean:
return(_settings.ExampleValues.Boolean);
case SchemaType.Integer:
return(_settings.ExampleValues.Integer);
case SchemaType.Number:
switch (schema?.GetSchemaFormat())
{
case SchemaFormat.Float:
return(_settings.ExampleValues.Float);
default:
return(_settings.ExampleValues.Double);
}
default:
switch (schema?.GetSchemaFormat())
{
case SchemaFormat.Date:
return(DateTimeUtils.ToRfc3339Date(_settings.ExampleValues.Date()));
case SchemaFormat.DateTime:
return(DateTimeUtils.ToRfc3339DateTime(_settings.ExampleValues.DateTime()));
case SchemaFormat.Byte:
return(_settings.ExampleValues.Bytes);
case SchemaFormat.Binary:
return(_settings.ExampleValues.Object);
default:
return(_settings.ExampleValues.String);
}
}
}
public static object GetExampleValue(OpenApiSchema schema)
{
switch (schema?.GetSchemaType())
{
case SchemaType.Boolean:
return(true);
case SchemaType.Integer:
return(42);
case SchemaType.Number:
switch (schema?.GetSchemaFormat())
{
case SchemaFormat.Float:
return(4.2f);
default:
return(4.2d);
}
default:
switch (schema?.GetSchemaFormat())
{
case SchemaFormat.Date:
return(DateTimeUtils.ToRfc3339Date(DateTime.UtcNow));
case SchemaFormat.DateTime:
return(DateTimeUtils.ToRfc3339DateTime(DateTime.UtcNow));
case SchemaFormat.Byte:
return(new byte[] { 48, 49, 50 });
case SchemaFormat.Binary:
return("example-object");
default:
return("example-string");
}
}
}
private static Dictionary <string, string> GetMapping(OpenApiSchema composedSchema)
{
if (composedSchema.GetSchemaType() != SchemaTypeEnum.ComposedSchema)
{
return(null);
}
var reverseMapping = new Dictionary <string, string>();
foreach (var schema in composedSchema.OneOf)
{
var schemaRef = schema.Reference?.ReferenceV3;
if (schemaRef == null)
{
throw new ArgumentNullException("invalid oneOf schema");
}
var schemaName = refPointer.GetRefName(schemaRef);
if (schemaName == null)
{
throw new ArgumentNullException("invalid schema: " + schemaRef);
}
reverseMapping.Add(schemaRef, schemaName);
}
if (!composedSchema.Discriminator.Mapping.IsNullOrEmpty())
{
foreach (var(key, value) in composedSchema.Discriminator.Mapping)
{
if (!reverseMapping.TryAdd(value, key))
{
reverseMapping[value] = key;
}
}
}
return(reverseMapping.ToDictionary(x => x.Value, x => x.Key));
}
private object MapSchemaToObject(OpenApiSchema schema, string name = null)
{
if (schema == null)
{
return(null);
}
switch (schema.GetSchemaType())
{
case SchemaType.Array:
var jArray = new JArray();
for (int i = 0; i < _settings.NumberOfArrayItems; i++)
{
if (schema.Items.Properties.Count > 0)
{
var arrayItem = new JObject();
foreach (var property in schema.Items.Properties)
{
var objectValue = MapSchemaToObject(property.Value, property.Key);
if (objectValue is JProperty jp)
{
arrayItem.Add(jp);
}
else
{
arrayItem.Add(new JProperty(property.Key, objectValue));
}
}
jArray.Add(arrayItem);
}
else
{
jArray.Add(MapSchemaToObject(schema.Items, name));
}
}
if (schema.AllOf.Count > 0)
{
jArray.Add(MapSchemaAllOfToObject(schema));
}
return(jArray);
case SchemaType.Boolean:
case SchemaType.Integer:
case SchemaType.Number:
case SchemaType.String:
return(_exampleValueGenerator.GetExampleValue(schema));
case SchemaType.Object:
var propertyAsJObject = new JObject();
foreach (var schemaProperty in schema.Properties)
{
propertyAsJObject.Add(MapPropertyAsJObject(schemaProperty.Value, schemaProperty.Key));
}
if (schema.AllOf.Count > 0)
{
foreach (var property in schema.AllOf)
{
foreach (var item in property.Properties)
{
propertyAsJObject.Add(MapPropertyAsJObject(item.Value, item.Key));
}
}
}
return(name != null ? new JProperty(name, propertyAsJObject) : (JToken)propertyAsJObject);
default:
return(null);
}
}
private object MapSchemaToObject(OpenApiSchema schema, string name = null)
{
if (schema == null)
{
return(null);
}
switch (schema.GetSchemaType())
{
case SchemaType.Array:
var jArray = new JArray();
for (int i = 0; i < _settings.NumberOfArrayItems; i++)
{
if (schema.Items.Properties.Count > 0)
{
var arrayItem = new JObject();
foreach (var property in schema.Items.Properties)
{
var objectValue = MapSchemaToObject(property.Value, property.Key);
if (objectValue is JProperty jp)
{
arrayItem.Add(jp);
}
else
{
arrayItem.Add(new JProperty(property.Key, objectValue));
}
}
jArray.Add(arrayItem);
}
else
{
jArray.Add(MapSchemaToObject(schema.Items, name));
}
}
return(jArray);
case SchemaType.Boolean:
case SchemaType.Integer:
case SchemaType.Number:
case SchemaType.String:
return(_exampleValueGenerator.GetExampleValue(schema));
case SchemaType.Object:
var propertyAsJObject = new JObject();
foreach (var schemaProperty in schema.Properties)
{
string propertyName = schemaProperty.Key;
var openApiSchema = schemaProperty.Value;
if (openApiSchema.GetSchemaType() == SchemaType.Object)
{
var mapped = MapSchemaToObject(schemaProperty.Value, schemaProperty.Key);
if (mapped is JProperty jp)
{
propertyAsJObject.Add(jp);
}
}
else
{
bool propertyIsNullable = openApiSchema.Nullable || (openApiSchema.TryGetXNullable(out bool x) && x);
propertyAsJObject.Add(new JProperty(propertyName, _exampleValueGenerator.GetExampleValue(openApiSchema)));
}
}
return(name != null ? new JProperty(name, propertyAsJObject) : (JToken)propertyAsJObject);
default:
return(null);
}
}
protected object MapSchema(OpenApiSchema schema, string name, bool isNullable, bool pascalCase, OpenApiSpecVersion?openApiSpecVersion)
{
if (schema == null)
{
return(null);
}
string nameCamelCase = string.IsNullOrEmpty(name) ? string.Empty : $" {(pascalCase ? name.ToPascalCase() : name)}";
bool nullableForOpenApi20 = openApiSpecVersion == OpenApiSpecVersion.OpenApi2_0 && Settings.GeneratePrimitivePropertiesAsNullableForOpenApi20;
string nullable = nullableForOpenApi20 || isNullable ? "?" : string.Empty;
switch (schema.GetSchemaType())
{
case SchemaType.Array:
switch (schema.Items.GetSchemaType())
{
case SchemaType.Object:
return(schema.Items.Reference != null ?
$"{MapArrayType(MakeValidModelName(schema.Items.Reference.Id))}{nameCamelCase}" :
$"{MapArrayType("object")}{nameCamelCase}");
case SchemaType.Unknown:
return($"{MapArrayType("object")}{nameCamelCase}");
default:
return($"{MapArrayType(MapSchema(schema.Items, null, schema.Items.Nullable, true, openApiSpecVersion))}{nameCamelCase}");
}
case SchemaType.Boolean:
return($"bool{nullable}{nameCamelCase}");
case SchemaType.Integer:
switch (schema.GetSchemaFormat())
{
case SchemaFormat.Int64:
return($"long{nullable}{nameCamelCase}");
default:
return($"int{nullable}{nameCamelCase}");
}
case SchemaType.Number:
switch (schema.GetSchemaFormat())
{
case SchemaFormat.Float:
return($"float{nullable}{nameCamelCase}");
default:
return($"double{nullable}{nameCamelCase}");
}
case SchemaType.String:
switch (schema.GetSchemaFormat())
{
case SchemaFormat.Date:
case SchemaFormat.DateTime:
return($"{DateTime}{nullable}{nameCamelCase}");
case SchemaFormat.Byte:
case SchemaFormat.Binary:
switch (Settings.ApplicationOctetStreamType)
{
case ApplicationOctetStreamType.Stream:
return($"System.IO.Stream{nameCamelCase}");
default:
return($"byte[]{nameCamelCase}");
}
default:
return($"string{nameCamelCase}");
}
case SchemaType.Object:
var list = new List <string>();
foreach (var schemaProperty in schema.Properties)
{
var openApiSchema = schemaProperty.Value;
if (openApiSchema.GetSchemaType() == SchemaType.Object)
{
string objectName = pascalCase ? schemaProperty.Key.ToPascalCase() : schemaProperty.Key;
string objectType = openApiSchema.Reference != null?MakeValidModelName(openApiSchema.Reference.Id) : "object";
list.Add($"{objectType} {objectName}");
}
else
{
bool propertyIsNullable = openApiSchema.Nullable ||
Settings.SupportExtensionXNullable && openApiSchema.TryGetXNullable(out bool x) && x;
var property = MapSchema(openApiSchema, schemaProperty.Key, propertyIsNullable, true, openApiSpecVersion);
if (property != null && property is string propertyAsString)
{
list.Add(propertyAsString);
}
}
}
return(list);
case SchemaType.File:
switch (Settings.MultipartFormDataFileType)
{
case MultipartFormDataFileType.Stream:
return($"System.IO.Stream{nameCamelCase}");
default:
return($"byte[]{nameCamelCase}");
}
default:
return(null);
}
}
