C# Academy · leksjon

Integrere validering med API-er

Returner ryddige svar på valideringsfeil.

Leksjon 4 av 413 trinn

Integrere validering med API-er er en gratis leksjon i C# Academy på CoddyKit. Dette er leksjon 4 av 4. Du kan lese hele leksjonen gratis nedenfor – og deretter øve praktisk i nettleseren med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt. Den er en del av læringsløpet i C# Academy, og fremdriften din synkroniseres mellom nettet og CoddyKit-appen. Kurset i C# Academy inneholder totalt 4 leksjoner.

Koble FluentValidation til ASP.NET Core

For å validere forespørsler automatisk registrerer du validatorene med avhengighetsinjeksjon. Hjelperen AddValidatorsFromAssembly skanner et assembly og registrerer alle validatorene den finner.

using FluentValidation;

builder.Services
    .AddValidatorsFromAssemblyContaining<CustomerValidator>();

Automatisk valideringsmellomvare

Moderne FluentValidation foretrekker eksplisitt validering, men du kan aktivere automatisk validering som kobler seg til modellbindingen, slik at ugyldige forespørsler avvises før handlingen din kjøres.

dotnet add package FluentValidation.AspNetCore

builder.Services.AddFluentValidationAutoValidation();

Validatorer hentet fra DI

Ettersom validatorene registreres med DI, kan de injisere tjenester som repositories. Dermed kan asynkrone regler som bruker databasen, fungere sømløst i API-et ditt.

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

Eksplisitt validering i et endepunkt

Mange team foretrekker eksplisitt validering fordi det gir tydelighet. Injiser IValidator<T> og kall den øverst i behandleren.

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();
});

Hva er ProblemDetails?

ProblemDetails (RFC 7807) er et standardisert JSON-format for HTTP-feilsvar. Det har felt som type, title, status og detail, slik at klienter får en forutsigbar feilstruktur.

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

ValidationProblemDetails

For valideringsfeil bruker ASP.NET Core ValidationProblemDetails, som utvider ProblemDetails med en errors-ordbok som knytter hvert felt til meldingene det har.

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

Konvertere FluentValidation-resultater

Utvidelsen ToDictionary() konverterer en ValidationResult til ordboken field -> messages som ValidationProblem forventer.

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

Tilpasse ProblemDetails-utdata

Bruk AddProblemDetails og en tilpasningsfunksjon for å berike alle feilsvar, for eksempel ved å legge til en sporings-ID for feilsøking.

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

Validering i MVC-kontrollere

Når automatisk validering er aktivert sammen med [ApiController], returnerer kontrollermetoder også automatisk ValidationProblemDetails når en forespørsel er ugyldig, slik at formatet er konsekvent på tvers av endepunkter.

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

Et valideringsfilter for Minimal APIs

Det er mulig å sentralisere eksplisitt validering med et endepunktfilter, slik at hver handler forblir ryddig.

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

Velge automatisk eller eksplisitt validering

Automatisk validering er praktisk, men skjuler valideringstrinnet. Eksplisitt validering er mer omstendelig, men tydeligere og enklere å teste. Mange team velger eksplisitt validering kombinert med et felles filter for å få det beste fra begge tilnærmingene.

Hurtigsjekk

Test integrasjonen av API-validering.

Besvar den i den interaktive leksjonen

Oppsummering

Integrering av validering innebærer å registrere validatorer med AddValidatorsFromAssembly, eventuelt aktivere automatisk validering og returnere feil som ValidationProblemDetails via Results.ValidationProblem(result.ToDictionary()). DI gjør det mulig for validatorer å bruke repositories for asynkrone regler, og De kan tilpasse ProblemDetails eller bruke endepunktfiltre for å holde handlere ryddige.

Gratis å komme i gang

Lær deg C# med en AI-veileder – gratis

Skriv og kjør ekte kode i nettleseren, få umiddelbar hjelp fra en AI-veileder som er tilgjengelig døgnet rundt, og fortsett der du slapp – på nettet eller i appen.

Kurs: 93
Leksjoner: 346

Start læringen gratis Se hele kurset

Ofte stilte spørsmål

Er leksjonen «Integrere validering med API-er» gratis?

Ja – hele teksten i «Integrere validering med API-er» er gratis å lese her på nettet. For å øve interaktivt med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt, og for å låse opp resten av C# Academy-kurset, kan du oppgradere til CoddyKit PRO. Kurset i C# Academy inneholder totalt 4 leksjoner.

Hva lærer jeg i «Integrere validering med API-er»?

Returner ryddige svar på valideringsfeil. Du øver på C# Academy med praktisk kode som du kjører direkte i nettleseren, mens en AI-veileder som er tilgjengelig døgnet rundt, svarer på spørsmålene dine mens du jobber deg gjennom leksjonen.

Trenger jeg erfaring for å begynne med C# Academy?

Ingen tidligere erfaring er nødvendig. C# Academy på CoddyKit er lagt opp for både nybegynnere og viderekomne, så De kan begynne her eller helt fra start og lære i Deres eget tempo. Dette er leksjon 4 av 4.

Hvor lang tid tar leksjonen «Integrere validering med API-er»?

De fleste CoddyKit-leksjoner tar omtrent 5–10 minutter. Hver leksjon er kort og interaktiv, slik at De gjør jevne fremskritt og kan fortsette akkurat der De slapp – både på nettet og i appen.

Kan jeg skrive og kjøre kode i denne C# Academy-leksjonen?

Ja. Alle C# Academy-leksjoner har en innebygd kodeeditor, slik at De kan skrive og kjøre ekte kode direkte i nettleseren og få umiddelbar tilbakemelding fra AI – uten lokal konfigurering.

Alle leksjonene i dette kurset

← Tilbake til C# Academy