public void add_parameter_should_add_descriptor_for_header()
{
// arrange
var version = new ApiVersion(1, 0);
var description = NewApiDescription(version);
var modelMetadata = new Mock <ModelMetadata>(ModelMetadataIdentity.ForType(typeof(string)));
var options = new ApiExplorerOptions()
{
DefaultApiVersion = version,
ApiVersionParameterSource = new HeaderApiVersionReader()
};
var context = new ApiVersionParameterDescriptionContext(description, version, modelMetadata.Object, options);
// act
context.AddParameter("api-version", Header);
// assert
description.ParameterDescriptions.Single().Should().BeEquivalentTo(
new
{
Name = "api-version",
ModelMetadata = modelMetadata,
Source = BindingSource.Header,
RouteInfo = new ApiParameterRouteInfo()
{
DefaultValue = "1.0",
IsOptional = false
},
Type = typeof(string)
},
o => o.ExcludingMissingMembers());
}
public void add_parameter_should_add_optional_parameter_when_allowed()
{
// arrange
var version = new ApiVersion(1, 0);
var description = NewApiDescription(version);
var modelMetadata = new Mock <ModelMetadata>(ModelMetadataIdentity.ForType(typeof(string)));
var options = new ApiExplorerOptions()
{
DefaultApiVersion = version,
ApiVersionParameterSource = new QueryStringApiVersionReader(),
AssumeDefaultVersionWhenUnspecified = true
};
var context = new ApiVersionParameterDescriptionContext(description, version, modelMetadata.Object, options);
// act
context.AddParameter("api-version", Query);
// assert
description.ParameterDescriptions.Single().Should().BeEquivalentTo(
new
{
Name = "api-version",
ModelMetadata = modelMetadata,
Source = BindingSource.Query,
RouteInfo = new ApiParameterRouteInfo()
{
DefaultValue = "1.0",
IsOptional = true
},
Type = typeof(string)
},
o => o.ExcludingMissingMembers());
}
public void add_parameter_should_not_add_query_parameter_after_path_parameter_has_been_added()
{
// arrange
var parameter = new ApiParameterDescription()
{
Name = "api-version",
RouteInfo = new ApiParameterRouteInfo()
{
Constraints = new IRouteConstraint[] { new ApiVersionRouteConstraint() }
},
Source = BindingSource.Path
};
var version = new ApiVersion(1, 0);
var description = NewApiDescription(version, parameter);
var modelMetadata = new Mock <ModelMetadata>(ModelMetadataIdentity.ForType(typeof(string)));
var options = new ApiExplorerOptions()
{
DefaultApiVersion = version,
ApiVersionParameterSource = Combine(new QueryStringApiVersionReader(), new UrlSegmentApiVersionReader())
};
var context = new ApiVersionParameterDescriptionContext(description, version, modelMetadata.Object, options);
modelMetadata.SetupGet(m => m.DataTypeName).Returns(nameof(ApiVersion));
// act
context.AddParameter("api-version", Path);
context.AddParameter("api-version", Query);
// assert
description.ParameterDescriptions.Should().HaveCount(1);
}
/// <summary>
/// Populates the API version parameters for the specified API description.
/// </summary>
/// <param name="apiDescription">The <see cref="ApiDescription">API description</see> to populate parameters for.</param>
/// <param name="apiVersion">The <see cref="ApiVersion">API version</see> used to populate parameters with.</param>
protected virtual void PopulateApiVersionParameters(ApiDescription apiDescription, ApiVersion apiVersion)
{
var parameterSource = Options.ApiVersionParameterSource;
var context = new ApiVersionParameterDescriptionContext(apiDescription, apiVersion, modelMetadata.Value, Options);
parameterSource.AddParameters(context);
}
public void add_parameter_should_add_descriptor_for_query_parameter()
{
// arrange
var version = new ApiVersion(1, 0);
var description = NewApiDescription(version);
var modelMetadata = new Mock <ModelMetadata>(ModelMetadataIdentity.ForType(typeof(string))).Object;
var options = new ApiExplorerOptions()
{
DefaultApiVersion = version,
ApiVersionParameterSource = new QueryStringApiVersionReader()
};
var context = new ApiVersionParameterDescriptionContext(description, version, modelMetadata, options);
// act
context.AddParameter("api-version", Query);
// assert
description.ParameterDescriptions.Single().Should().BeEquivalentTo(
new
{
Name = "api-version",
ModelMetadata = modelMetadata,
Source = BindingSource.Query,
DefaultValue = (object)"1.0",
IsRequired = true,
Type = typeof(string),
},
o => o.ExcludingMissingMembers());
}
/// <summary>
/// Populates the API version parameters for the specified API description.
/// </summary>
/// <param name="apiDescription">The <see cref="ApiDescription">API description</see> to populate parameters for.</param>
/// <param name="apiVersion">The <see cref="ApiVersion">API version</see> used to populate parameters with.</param>
protected virtual void PopulateApiVersionParameters(ApiDescription apiDescription, ApiVersion apiVersion)
{
Arg.NotNull(apiDescription, nameof(apiDescription));
Arg.NotNull(apiVersion, nameof(apiVersion));
var action = apiDescription.ActionDescriptor;
var model = action.GetProperty <ApiVersionModel>();
if (model.IsApiVersionNeutral)
{
return;
}
else if (model.DeclaredApiVersions.Count == 0)
{
model = action.GetProperty <ControllerModel>()?.GetProperty <ApiVersionModel>();
if (model?.IsApiVersionNeutral == true)
{
return;
}
}
var parameterSource = Options.ApiVersionParameterSource;
var context = new ApiVersionParameterDescriptionContext(apiDescription, apiVersion, modelMetadata.Value, Options);
parameterSource.AddParameters(context);
}
public void add_parameter_should_remove_other_descriptors_after_path_parameter_is_added()
{
// arrange
var parameter = new ApiParameterDescription()
{
Name = "api-version",
RouteInfo = new ApiParameterRouteInfo()
{
Constraints = new IRouteConstraint[] { new ApiVersionRouteConstraint() }
},
Source = BindingSource.Path
};
var description = new ApiDescription()
{
ParameterDescriptions = { parameter }
};
var version = new ApiVersion(1, 0);
var modelMetadata = new Mock <ModelMetadata>(ModelMetadataIdentity.ForType(typeof(string)));
var options = new ApiExplorerOptions()
{
DefaultApiVersion = version,
ApiVersionParameterSource = Combine(new QueryStringApiVersionReader(), new UrlSegmentApiVersionReader())
};
var context = new ApiVersionParameterDescriptionContext(description, version, modelMetadata.Object, options);
modelMetadata.SetupGet(m => m.DataTypeName).Returns(nameof(ApiVersion));
// act
context.AddParameter("api-version", Query);
context.AddParameter("api-version", Path);
// assert
description.ParameterDescriptions.Single().ShouldBeEquivalentTo(
new
{
Name = "api-version",
ModelMetadata = modelMetadata,
Source = BindingSource.Path,
RouteInfo = new ApiParameterRouteInfo()
{
DefaultValue = "1.0",
IsOptional = false,
Constraints = parameter.RouteInfo.Constraints
},
Type = typeof(string)
},
o => o.ExcludingMissingMembers());
}
public void add_parameter_should_add_descriptor_for_media_type_parameter()
{
// arrange
const string Json = "application/json";
var version = new ApiVersion(1, 0);
var description = new ApiDescription()
{
ActionDescriptor = new ActionDescriptor()
{
Properties = { [typeof(ApiVersionModel)] = new ApiVersionModel(version) }
},
SupportedRequestFormats =
{
new ApiRequestFormat()
{
MediaType = Json
}
},
SupportedResponseTypes =
{
new ApiResponseType()
{
ApiResponseFormats =
{
new ApiResponseFormat()
{
MediaType = Json
}
}
}
}
};
var modelMetadata = new Mock <ModelMetadata>(ModelMetadataIdentity.ForType(typeof(string)));
var options = new ApiExplorerOptions()
{
DefaultApiVersion = version,
ApiVersionParameterSource = new MediaTypeApiVersionReader()
};
var context = new ApiVersionParameterDescriptionContext(description, version, modelMetadata.Object, options);
// act
context.AddParameter("v", MediaTypeParameter);
// assert
description.SupportedRequestFormats.Single().MediaType.Should().Be("application/json; v=1.0");
description.SupportedResponseTypes.Single().ApiResponseFormats.Single().MediaType.Should().Be("application/json; v=1.0");
}
public void add_parameter_should_add_descriptor_for_path()
{
// arrange
var parameter = new ApiParameterDescription()
{
Name = "api-version",
RouteInfo = new ApiParameterRouteInfo()
{
Constraints = new IRouteConstraint[] { new ApiVersionRouteConstraint() }
},
Source = BindingSource.Path
};
var version = new ApiVersion(1, 0);
var description = NewApiDescription(version, parameter);
var modelMetadata = new Mock <ModelMetadata>(ModelMetadataIdentity.ForType(typeof(string))).Object;
var options = new ApiExplorerOptions()
{
DefaultApiVersion = version,
ApiVersionParameterSource = new UrlSegmentApiVersionReader()
};
var context = new ApiVersionParameterDescriptionContext(description, version, modelMetadata, options);
// act
context.AddParameter("api-version", Path);
// assert
description.ParameterDescriptions.Single().Should().BeEquivalentTo(
new
{
Name = "api-version",
ModelMetadata = modelMetadata,
Source = BindingSource.Path,
DefaultValue = (object)"1.0",
IsRequired = true,
RouteInfo = new ApiParameterRouteInfo()
{
DefaultValue = "1.0",
IsOptional = false,
Constraints = parameter.RouteInfo.Constraints,
},
Type = typeof(string),
},
o => o.ExcludingMissingMembers());
}
public void add_parameter_should_make_parameters_optional_after_first_parameter()
{
// arrange
var version = new ApiVersion(1, 0);
var description = NewApiDescription(version);
var modelMetadata = new Mock <ModelMetadata>(ModelMetadataIdentity.ForType(typeof(string)));
var options = new ApiExplorerOptions()
{
DefaultApiVersion = version,
ApiVersionParameterSource = Combine(new QueryStringApiVersionReader(), new HeaderApiVersionReader())
};
var context = new ApiVersionParameterDescriptionContext(description, version, modelMetadata.Object, options);
// act
context.AddParameter("api-version", Query);
context.AddParameter("api-version", Header);
// assert
description.ParameterDescriptions[0].RouteInfo.IsOptional.Should().BeFalse();
description.ParameterDescriptions[1].RouteInfo.IsOptional.Should().BeTrue();
}
