private void AddPrimitiveParametersFromUri(SwaggerService service, SwaggerOperation operation, ParameterInfo parameter, ISchemaResolver schemaResolver)
{
foreach (var property in parameter.ParameterType.GetRuntimeProperties())
{
var attributes = property.GetCustomAttributes().ToList();
var operationParameter = CreatePrimitiveParameter(// TODO: Check if there is a way to control the property name
service, JsonPathUtilities.GetPropertyName(property, Settings.DefaultPropertyNameHandling),
property.GetXmlDocumentation(), property.PropertyType, attributes, schemaResolver);
// TODO: Check if required can be controlled with mechanisms other than RequiredAttribute
var parameterInfo = JsonObjectTypeDescription.FromType(property.PropertyType, attributes, Settings.DefaultEnumHandling);
var isFileArray = IsFileArray(property.PropertyType, parameterInfo);
if (parameterInfo.Type == JsonObjectType.File || isFileArray)
{
InitializeFileParameter(operationParameter, isFileArray);
}
else
{
operationParameter.Kind = SwaggerParameterKind.Query;
}
operation.Parameters.Add(operationParameter);
}
}
public void When_object_is_root_then_path_should_be_built_correctly()
{
//// Arrange
var objectToSearch = new JsonSchema4();
//// Act
var path = JsonPathUtilities.GetJsonPath(objectToSearch, objectToSearch);
//// Assert
Assert.AreEqual("#", path);
}
public void When_object_is_root_then_path_should_be_built_correctly()
{
//// Arrange
var objectToSearch = new JsonSchema4();
//// Act
var foundObject = JsonPathUtilities.GetObjectFromJsonPath(objectToSearch, "#");
//// Assert
Assert.AreEqual(foundObject, objectToSearch);
}
public void When_object_is_in_property_then_path_should_be_built_correctly()
{
//// Arrange
var objectToSearch = new JsonSchema4();
var obj = new
{
Property = new
{
Property1 = new { },
Property2 = objectToSearch
}
};
//// Act
var path = JsonPathUtilities.GetJsonPath(obj, objectToSearch);
//// Assert
Assert.AreEqual("#/Property/Property2", path);
}
public void When_object_is_in_dictionary_then_path_should_be_built_correctly()
{
//// Arrange
var objectToSearch = new JsonSchema4();
var obj = new
{
Property = new
{
List = new Dictionary <string, object>
{
{ "Test1", new { } },
{ "Test2", new { } },
{ "Test3", objectToSearch },
}
}
};
//// Act
var path = JsonPathUtilities.GetJsonPath(obj, objectToSearch);
//// Assert
Assert.AreEqual("#/Property/List/Test3", path);
}
public void When_object_is_in_list_then_path_should_be_built_correctly()
{
//// Arrange
var objectToSearch = new JsonSchema4();
var obj = new
{
Property = new
{
List = new List <object>
{
new { },
new { },
objectToSearch
}
}
};
//// Act
var path = JsonPathUtilities.GetJsonPath(obj, objectToSearch);
//// Assert
Assert.Equal("#/Property/List/2", path);
}
private void LoadPropertyOrField(MemberInfo property, Type propertyType, Type parentType, JsonSchema4 parentSchema, ISchemaResolver schemaResolver, ISchemaDefinitionAppender schemaDefinitionAppender)
{
var attributes = property.GetCustomAttributes(inherit: true).OfType <Attribute>().ToArray();
var propertyTypeDescription = JsonObjectTypeDescription.FromType(propertyType, attributes, Settings.DefaultEnumHandling);
if (IsPropertyIgnored(parentType, attributes) == false)
{
JsonProperty jsonProperty;
if (propertyType.Name == "Nullable`1")
#if !LEGACY
{ propertyType = propertyType.GenericTypeArguments[0]; }
#else
{ propertyType = propertyType.GetGenericArguments()[0]; }
#endif
var requiresSchemaReference = RequiresSchemaReference(propertyType, attributes);
if (requiresSchemaReference)
{
var propertySchema = Generate <JsonSchema4>(propertyType, attributes, schemaResolver, schemaDefinitionAppender);
// The schema is automatically added to Definitions if it is missing in JsonPathUtilities.GetJsonPath()
if (Settings.NullHandling == NullHandling.JsonSchema)
{
jsonProperty = new JsonProperty();
jsonProperty.OneOf.Add(new JsonSchema4
{
SchemaReference = propertySchema.ActualSchema
});
}
else
{
jsonProperty = new JsonProperty
{
SchemaReference = propertySchema.ActualSchema
};
}
}
else
{
jsonProperty = Generate <JsonProperty>(propertyType, attributes, schemaResolver, schemaDefinitionAppender);
}
var propertyName = JsonPathUtilities.GetPropertyName(property, Settings.DefaultPropertyNameHandling);
if (parentSchema.Properties.ContainsKey(propertyName))
{
throw new InvalidOperationException("The JSON property '" + propertyName + "' is defined multiple times on type '" + parentType.FullName + "'.");
}
parentSchema.Properties.Add(propertyName, jsonProperty);
var requiredAttribute = attributes.TryGetIfAssignableTo("System.ComponentModel.DataAnnotations.RequiredAttribute");
var jsonPropertyAttribute = attributes.OfType <JsonPropertyAttribute>().SingleOrDefault();
var hasJsonNetAttributeRequired = jsonPropertyAttribute != null && (
jsonPropertyAttribute.Required == Required.Always ||
jsonPropertyAttribute.Required == Required.AllowNull);
var isDataContractMemberRequired = GetDataMemberAttribute(parentType, attributes)?.IsRequired == true;
var hasRequiredAttribute = requiredAttribute != null;
if (hasRequiredAttribute || isDataContractMemberRequired || hasJsonNetAttributeRequired)
{
parentSchema.RequiredProperties.Add(propertyName);
}
var isJsonNetAttributeNullable = jsonPropertyAttribute != null && jsonPropertyAttribute.Required == Required.AllowNull;
var isNullable = !hasRequiredAttribute && !isDataContractMemberRequired && (propertyTypeDescription.IsNullable || isJsonNetAttributeNullable);
if (isNullable)
{
if (Settings.NullHandling == NullHandling.JsonSchema)
{
if (requiresSchemaReference)
{
jsonProperty.OneOf.Add(new JsonSchema4 {
Type = JsonObjectType.Null
});
}
else if (jsonProperty.Type == JsonObjectType.None)
{
jsonProperty.OneOf.Add(new JsonSchema4 {
Type = JsonObjectType.None
});
jsonProperty.OneOf.Add(new JsonSchema4 {
Type = JsonObjectType.Null
});
}
else
{
jsonProperty.Type = jsonProperty.Type | JsonObjectType.Null;
}
}
}
else if (Settings.NullHandling == NullHandling.Swagger)
{
if (!parentSchema.RequiredProperties.Contains(propertyName))
{
parentSchema.RequiredProperties.Add(propertyName);
}
}
dynamic readOnlyAttribute = attributes.TryGetIfAssignableTo("System.ComponentModel.ReadOnlyAttribute");
if (readOnlyAttribute != null)
{
jsonProperty.IsReadOnly = readOnlyAttribute.IsReadOnly;
}
jsonProperty.Description = GetDescription(property, attributes);
ApplyPropertyAnnotations(jsonProperty, parentType, attributes, propertyTypeDescription);
}
}
private void LoadProperty(Type parentType, PropertyInfo property, JsonSchema4 parentSchema, JsonSchema4 rootSchema,
ISchemaDefinitionAppender schemaDefinitionAppender, ISchemaResolver schemaResolver)
{
var propertyType = property.PropertyType;
var propertyTypeDescription = JsonObjectTypeDescription.FromType(propertyType, property.GetCustomAttributes(), Settings.DefaultEnumHandling);
var attributes = property.GetCustomAttributes().ToArray();
if (IsPropertyIgnored(parentType, attributes) == false)
{
JsonProperty jsonProperty;
if (propertyType.Name == "Nullable`1")
{
propertyType = propertyType.GenericTypeArguments[0];
}
var useSchemaReference = !propertyTypeDescription.IsDictionary && (propertyTypeDescription.Type.HasFlag(JsonObjectType.Object) || propertyTypeDescription.IsEnum);
if (useSchemaReference)
{
// schema is automatically added to Definitions if it is missing in JsonPathUtilities.GetJsonPath()
var propertySchema = Generate(propertyType, rootSchema,
property.GetCustomAttributes(), schemaDefinitionAppender, schemaResolver);
if (Settings.NullHandling == NullHandling.JsonSchema)
{
jsonProperty = new JsonProperty();
jsonProperty.OneOf.Add(new JsonSchema4
{
SchemaReference = propertySchema.ActualSchema
});
}
else
{
jsonProperty = new JsonProperty
{
SchemaReference = propertySchema.ActualSchema
};
}
}
else
{
jsonProperty = Generate <JsonProperty>(propertyType, rootSchema, property.GetCustomAttributes(), schemaDefinitionAppender, schemaResolver);
propertyTypeDescription.ApplyType(jsonProperty);
}
var propertyName = JsonPathUtilities.GetPropertyName(property);
parentSchema.Properties.Add(propertyName, jsonProperty);
var requiredAttribute = TryGetAttribute(attributes, "System.ComponentModel.DataAnnotations.RequiredAttribute");
var jsonPropertyAttribute = property.GetCustomAttribute <JsonPropertyAttribute>();
var hasJsonNetAttributeRequired = jsonPropertyAttribute != null && (
jsonPropertyAttribute.Required == Required.Always ||
jsonPropertyAttribute.Required == Required.AllowNull);
var hasRequiredAttribute = requiredAttribute != null;
if (hasRequiredAttribute || hasJsonNetAttributeRequired)
{
parentSchema.RequiredProperties.Add(propertyName);
}
var isJsonNetAttributeNullable = jsonPropertyAttribute != null && jsonPropertyAttribute.Required == Required.AllowNull;
var isNullable = !hasRequiredAttribute && (propertyTypeDescription.IsNullable || isJsonNetAttributeNullable);
if (isNullable)
{
if (Settings.NullHandling == NullHandling.JsonSchema)
{
if (useSchemaReference)
{
jsonProperty.OneOf.Add(new JsonSchema4 {
Type = JsonObjectType.Null
});
}
else
{
jsonProperty.Type = jsonProperty.Type | JsonObjectType.Null;
}
}
}
else if (Settings.NullHandling == NullHandling.Swagger)
{
if (!parentSchema.RequiredProperties.Contains(propertyName))
{
parentSchema.RequiredProperties.Add(propertyName);
}
}
dynamic readOnlyAttribute = TryGetAttribute(attributes, "System.ComponentModel.ReadOnlyAttribute");
if (readOnlyAttribute != null)
{
jsonProperty.IsReadOnly = readOnlyAttribute.IsReadOnly;
}
jsonProperty.Description = GetDescription(property, attributes);
ApplyPropertyAnnotations(jsonProperty, attributes, propertyTypeDescription);
}
}
private void AddPrimitiveParametersFromUri(string name, SwaggerOperation operation, ParameterInfo parameter, JsonObjectTypeDescription typeDescription, SwaggerGenerator swaggerGenerator)
{
if (typeDescription.Type.HasFlag(JsonObjectType.Array))
{
var operationParameter = swaggerGenerator.CreatePrimitiveParameter(name,
parameter.GetXmlDocumentation(), parameter.ParameterType.GetEnumerableItemType(), parameter.GetCustomAttributes().ToList());
operationParameter.Kind = SwaggerParameterKind.Query;
operationParameter.CollectionFormat = SwaggerParameterCollectionFormat.Multi;
operation.Parameters.Add(operationParameter);
}
else
{
foreach (var property in parameter.ParameterType.GetRuntimeProperties())
{
var attributes = property.GetCustomAttributes().ToList();
var fromQueryAttribute = attributes.SingleOrDefault(a => a.GetType().Name == "FromQueryAttribute");
var propertyName = TryGetStringPropertyValue(fromQueryAttribute, "Name") ?? JsonPathUtilities.GetPropertyName(property, _settings.DefaultPropertyNameHandling);
var operationParameter = swaggerGenerator.CreatePrimitiveParameter(propertyName, property.GetXmlSummary(), property.PropertyType, attributes);
// TODO: Check if required can be controlled with mechanisms other than RequiredAttribute
var parameterInfo = JsonObjectTypeDescription.FromType(property.PropertyType, attributes, _settings.DefaultEnumHandling);
var isFileArray = IsFileArray(property.PropertyType, parameterInfo);
if (parameterInfo.Type == JsonObjectType.File || isFileArray)
{
InitializeFileParameter(operationParameter, isFileArray);
}
else
{
operationParameter.Kind = SwaggerParameterKind.Query;
}
operation.Parameters.Add(operationParameter);
}
}
}
