WebApiClient的接口输入验证方法

WebApiClient是一款可以支持自动生成HTTP请求客户端的工具，它可以通过定义接口的方式，直接调用HTTP接口。在使用WebApiClient进行接口调用时，由于接口输入参数不符合要求可能会导致接口请求失败，因此需要对接口输入参数进行验证。

下面是WebApiClient的接口输入验证方法的完整攻略：

1. 在接口定义中使用数据注解进行验证

在WebApiClient接口定义中，可以使用数据注解（Data Annotations）来标注接口的输入参数，来验证接口输入参数的正确性。

数据注解有许多种，例如：

• RequiredAttribute：表示该属性是必须的；
• RangeAttribute：表示该属性必须在指定的范围内；
• StringLengthAttribute：表示该字符串属性的长度必须在指定的范围内。

使用数据注解在接口定义中进行验证，需要按照以下步骤进行：

1. 引入System.ComponentModel.DataAnnotations命名空间；
2. 为接口方法的输入参数添加数据注解，例如：

using System.ComponentModel.DataAnnotations;

public interface IUserApi : IHttpApi
{
    [HttpPost("/users")]
    Task CreateUserAsync([Required]string name, [Range(1, 120)]int age);
}

1. 在验证失败时抛出异常，例如：

using WebApiClient;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Net.Http;
using System.Threading.Tasks;

public class UserApi : HttpApi, IUserApi
{
    public UserApi(HttpClient httpClient) : base(httpClient)
    {
    }

    [HttpPost("/users")]
    public async Task CreateUserAsync([Required]string name, [Range(1, 120)]int age)
    {
        if (!Validator.TryValidateProperty(name, new ValidationContext(this) { MemberName = "name" }, null))
        {
            throw new HttpRequestException("name参数不能为空。");
        }

        if (!Validator.TryValidateProperty(age, new ValidationContext(this) { MemberName = "age" }, null))
        {
            throw new HttpRequestException("age参数不在合法范围内。");
        }

        // 发起HTTP请求
        await base.PostAsJsonAsync("/users", new { name, age });
    }
}

2. 使用FluentValidation进行验证

除了使用数据注解进行验证之外，还可以使用FluentValidation库进行验证，FluentValidation支持链式语法，可以方便地对接口输入参数进行验证。

使用FluentValidation进行验证，需要按照以下步骤进行：

1. 引入FluentValidation和FluentValidation.Results命名空间；
2. 定义一个验证器类，对接口输入参数进行验证规则的定义，例如：

using FluentValidation;

public class CreateUserDtoValidator : AbstractValidator<CreateUserDto>
{
    public CreateUserDtoValidator()
    {
        RuleFor(x => x.Name).NotEmpty();
        RuleFor(x => x.Age).InclusiveBetween(1, 120);
    }
}

1. 在接口定义中通过[Validator(typeof(CreateUserDtoValidator))]将验证器类注入到接口方法中，例如：

using WebApiClient;
using FluentValidation;
using FluentValidation.Results;
using System.Net.Http;
using System.Threading.Tasks;

public interface IUserApi : IHttpApi
{
    [Validator(typeof(CreateUserDtoValidator))]
    [HttpPost("/users")]
    Task CreateUserAsync(CreateUserDto createUserDto);
}

public class UserApi : HttpApi, IUserApi
{
    public UserApi(HttpClient httpClient) : base(httpClient)
    {
    }

    public async Task CreateUserAsync(CreateUserDto createUserDto)
    {
        var validationResult = await new CreateUserDtoValidator().ValidateAsync(createUserDto);

        if (!validationResult.IsValid)
        {
            var errorMessages = validationResult.Errors.Select(x => x.ErrorMessage);
            throw new HttpRequestException(string.Join(",", errorMessages));
        }

        // 发起HTTP请求
        await base.PostAsJsonAsync("/users", createUserDto);
    }
}

通过上述两种方法，我们可以对接口输入参数进行验证，来保证接口调用的正确性。以下是示例代码：

var userApi = HttpApiClient.Create<IUserApi>();
try
{
    await userApi.CreateUserAsync(new CreateUserDto { Name = "", Age = 150 });
}
catch (HttpRequestException ex)
{
    Console.WriteLine($"请求异常：{ex.Message}");
}

try
{
    await userApi.CreateUserAsync(new CreateUserDto { Name = "Tom", Age = 20 });
}
catch (HttpRequestException ex)
{
    Console.WriteLine($"请求异常：{ex.Message}");
}