0Pricing
C# Academy · 课时

将验证集成到 API

返回简洁的验证错误响应。

将验证集成到 API 是 CoddyKit 上的免费 C# Academy 课时。 这是第 4 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 C# Academy 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 C# Academy 课程共包含 4 节课。

将 FluentValidation 接入 ASP.NET Core

若要自动验证请求，请通过依赖注入注册验证器。AddValidatorsFromAssembly 辅助方法会扫描程序集，并注册找到的每个验证器。

using FluentValidation;

builder.Services
    .AddValidatorsFromAssemblyContaining<CustomerValidator>();

自动验证中间件

现代 FluentValidation 更倾向于显式验证，但您也可以启用自动验证，将其接入模型绑定流程，使无效请求在操作方法运行前被拒绝。

dotnet add package FluentValidation.AspNetCore

builder.Services.AddFluentValidationAutoValidation();

从 DI 解析验证器

由于验证器已通过 DI 注册，因此可以注入仓储等服务，让基于数据库的异步规则在 API 中顺畅运行。

public class UserValidator : AbstractValidator<UserRequest>
{
    public UserValidator(IUserRepository repo)
    {
        RuleFor(u => u.Email)
            .MustAsync(async (e, ct) => !await repo.ExistsAsync(e));
    }
}

在端点中执行显式验证

许多团队更喜欢显式验证，因为这种方式更清晰。请注入 IValidator<T>，并在 handler 开始处调用它。

app.MapPost("/users", async (
    UserRequest request,
    IValidator<UserRequest> validator) =>
{
    var result = await validator.ValidateAsync(request);
    if (!result.IsValid)
        return Results.ValidationProblem(result.ToDictionary());
    return Results.Ok();
});

什么是 ProblemDetails

ProblemDetails（RFC 7807）是 HTTP 错误响应的标准 JSON 格式。它包含 type、title、status 和 detail 等字段，为客户端提供可预测的错误结构。

{
  "type": "https://tools.ietf.org/html/rfc7231",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": { "Email": ["Email is required."] }
}

ValidationProblemDetails

对于验证失败，ASP.NET Core 使用 ValidationProblemDetails，它扩展了 ProblemDetails，并通过 errors 字典将每个字段映射到对应的消息。

return Results.ValidationProblem(result.ToDictionary());
// Produces a 400 ValidationProblemDetails response

转换 FluentValidation 结果

ToDictionary() 扩展方法会将 ValidationResult 转换为 ValidationProblem 所需的 field -> messages 字典。

var result = await validator.ValidateAsync(request);
if (!result.IsValid)
{
    IDictionary<string, string[]> errors = result.ToDictionary();
    return Results.ValidationProblem(errors);
}

自定义 ProblemDetails 输出

使用 AddProblemDetails 和自定义器丰富每个错误响应，例如添加跟踪 ID 以便调试。

builder.Services.AddProblemDetails(options =>
{
    options.CustomizeProblemDetails = ctx =>
        ctx.ProblemDetails.Extensions["traceId"] =
            ctx.HttpContext.TraceIdentifier;
});

MVC 控制器中的验证

启用自动验证并使用 [ApiController] 后，当请求无效时，控制器操作也会自动返回 ValidationProblemDetails，因此所有端点的格式保持一致。

[ApiController]
[Route("api/[controller]")]
public class UsersController : ControllerBase
{
    [HttpPost]
    public IActionResult Create(UserRequest request) => Ok();
}

最小 API 的验证筛选器

您可以通过端点筛选器集中处理显式验证，让每个处理程序保持简洁。

app.MapPost("/users", (UserRequest r) => Results.Ok())
   .AddEndpointFilter<ValidationFilter<UserRequest>>();

选择自动验证还是显式验证

自动验证很方便，但会隐藏验证步骤；显式验证虽然冗长，却更透明，也更容易测试。许多团队会选择显式验证加共享筛选器，以兼得两者的优点。

快速检查

测试 API 验证集成。

回顾

集成验证意味着使用 AddValidatorsFromAssembly 注册验证器，可选择启用自动验证，并通过 Results.ValidationProblem(result.ToDictionary()) 将错误作为 ValidationProblemDetails 返回。DI 允许验证器在 async 规则中使用存储库，您还可以自定义 ProblemDetails，或使用端点筛选器让处理程序保持简洁。

常见问题解答

「将验证集成到 API」课时是免费的吗？

是的 — 「将验证集成到 API」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 C# Academy 课程的其余内容，请升级到 CoddyKit PRO。 C# Academy 课程共包含 4 节课。

「将验证集成到 API」这节课中我会学到什么？

返回简洁的验证错误响应。 你通过在浏览器中直接运行的动手代码来练习 C# Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 C# Academy 需要有经验吗？

无需任何先前经验。CoddyKit 上的 C# Academy 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 4 节课，共 4 节。

「将验证集成到 API」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 C# Academy 课中编写并运行代码吗？

能。每节 C# Academy 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 数据注解验证
  2. FluentValidation 规则
  3. 自定义规则与条件规则
  4. 将验证集成到 API
← 返回 C# Academy