Welcome to Software Development on Codidact!
Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.
Can Swashbuckle.AspNetCore generate exclusiveMinimum validation?
Is there a way to make Swashbuckle.AspNetCore generate a Swagger exclusiveMinimum range validation for a model property?
There doesn't seem to be any way to do this with the attributes recognized by OpenApiSchemaExtensions.ApplyValidationAttributes. Searching the code for "exclusiveMinimum" does produce results, but only in relation to validating client-submitted JSON. So there seems to be no built-in way to do this. But is there an extension point that could be used for this?
1 answer
This can be achieved with a schema filter. For this proof of concept, I based the filter on a custom attribute:
[AttributeUsage(AttributeTargets.Property)]
public class GreaterThanAttribute(double exclusiveMinimum) : Attribute
{
public double ExclusiveMinimum { get; } = exclusiveMinimum;
}
public class GreaterThanFilter : ISchemaFilter
{
public void Apply(OpenApiSchema schema, SchemaFilterContext context)
{
if (context.MemberInfo?.MemberType == MemberTypes.Property)
{
var attr = context.MemberInfo.GetCustomAttribute<GreaterThanAttribute>();
if (attr != null)
{
schema.ExclusiveMinimum = true;
schema.Minimum = (decimal)attr.ExclusiveMinimum;
}
}
}
}
Add the schema filter to SwaggerGenOptions:
services.AddSwaggerGen(options => options.SchemaFilter<GreaterThanFilter>());
The attributes that Swashbuckle recognizes by default are also recognized by EF Core. For consistency, you could also look for your custom attribute in your EF context OnModelCreating and make corresponding changes to the EF model.
0 comment threads
0 comment threads