数据验证

目前请求的Request支持数据验证,同时支持FluentValidation和MSDataAnnotations的验证方式,在Request对象中继承BaseRequest,并且在构造函数中调用RuleFor方法进行验证规则的设置,如下所示:

public class HelloApiRequest : BaseRequest<HelloApiRequest>
{
	[Description("Name Desc")]
	public string Name { get; set; } = null!;

	/// <summary>
	/// FromQuery特性绑定字段
	/// </summary>
	[FromQuery("q"),Required]
	public string? Q { get; set; }

	public HelloApiRequest()
	{
		RuleFor(x => x.Name).NotNull().Length(5, 10);
	}
}

使用DataAnnotations的方式,可以直接在属性上使用Required等特性,如上所示,Q属性使用了Required特性,表示这个属性是必填的,如果不填写,则会返回400错误。使用FluentValidation的方式,在构造函数中调用RuleFor方法,设置验证规则,如上所示,Name属性设置了NotNull和Length验证规则,表示这个属性不能为空,并且长度在5-10之间。

Note

Request的验证不仅可以在QuickApi和QuickEndpoint中使用,你可以在任意地方调用Validate方法进行验证,如下所示:

var request = new HelloApiRequest
{
	Name = "Tom",
	Q = "Hello"
};
var result = request.Validate();
if (!result.IsValid)
{
	//验证失败
}
else
{
	//验证成功
}

Table of Contents

数据验证

Note

API文档