Menu
CoddyTech

Terminer une requête prématurément

Fait partie de la section Minimal APIs du Journey ASP.NET Core de Coddy. Leçon 14 sur 20.

Un middleware qui n'appelle pas next() termine la requête à cet endroit et y répond lui-même : le middleware situé en dessous, les fichiers statiques et les points de terminaison ne sont jamais exécutés.

app.Use(async (context, next) =>
{
    if (context.Request.Path.StartsWithSegments("/admin"))
    {
        context.Response.StatusCode = 403;
        await context.Response.WriteAsync("Forbidden");
        return;
    }
    await next();
});

StartsWithSegments("/admin") est vrai pour /admin et /admin/users, mais pas pour /administrator. Pour rediriger le client vers une autre adresse, context.Response.Redirect(url, permanent: true) répond avec le statut 301 Moved Permanently et l'adresse dans l'en-tête Location, puis le navigateur envoie une requête à cette adresse. Sans permanent: true, la réponse est 302 Found, une redirection temporaire.

challenge icon

Défi

Facile

L’API se trouvait auparavant à /recipes, sans /api. Les anciens liens mènent aux nouvelles adresses.

  1. Dans Program.cs, sous le middleware X-Api-Version et au-dessus de app.UseStaticFiles();, ajoute un autre middleware app.Use.
  2. Lorsque context.Request.Path.StartsWithSegments("/recipes"), appelle context.Response.Redirect("/api" + context.Request.Path + context.Request.QueryString, permanent: true);, puis return sans appeler next().
  3. Sinon, await next();.

Essaie : appuie sur « Exécuter ». La première requête est GET /recipes/2 : statut 301, et l’onglet Headers affiche Location: /api/recipes/2 et X-Api-Version: 1. Envoie GET /recipes?category=soup : Location: /api/recipes?category=soup. Envoie GET /api/recipes/2 : 200, sans redirection.

Essayez vous-même

using Microsoft.AspNetCore.Http.HttpResults;

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

app.Use(async (context, next) =>
{
    context.Response.Headers["X-Api-Version"] = "1";
    await next();
});

app.UseStaticFiles();

var recipes = new List<Recipe>
{
    new(1, "Tomato Soup", "soup", 25),
    new(2, "Pancakes", "breakfast", 15),
    new(3, "Lentil Soup", "soup", 40),
};
var nextId = 4;
var favoriteIds = new List<int>();

app.MapGet("/", () => "Recipe API is running");
app.MapGet("/api/recipes", (string? category) =>
    recipes.Where(r => category is null || r.Category == category));
app.MapGet("/api/recipes/{id:int}", (int id) =>
{
    var recipe = recipes.FirstOrDefault(r => r.Id == id);
    if (recipe is null)
        return Results.NotFound(new { error = $"Recipe {id} not found" });
    return Results.Ok(recipe);
});

app.MapPost("/api/recipes", (NewRecipe input) =>
{
    if (string.IsNullOrWhiteSpace(input.Name))
        return Results.BadRequest(new { error = "Name is required" });
    if (input.Minutes <= 0)
        return Results.BadRequest(new { error = "Minutes must be more than 0" });
    var recipe = new Recipe(nextId++, input.Name, input.Category, input.Minutes);
    recipes.Add(recipe);
    return Results.Created($"/api/recipes/{recipe.Id}", recipe);
});

app.MapPut("/api/recipes/{id:int}", (int id, NewRecipe input) =>
{
    var index = recipes.FindIndex(r => r.Id == id);
    if (index == -1)
        return Results.NotFound(new { error = $"Recipe {id} not found" });
    var recipe = new Recipe(id, input.Name, input.Category, input.Minutes);
    recipes[index] = recipe;
    return Results.Ok(recipe);
});

app.MapDelete("/api/recipes/{id:int}", Results<NoContent, NotFound> (int id) =>
{
    var removed = recipes.RemoveAll(r => r.Id == id);
    return removed > 0 ? TypedResults.NoContent() : TypedResults.NotFound();
});

var favorites = app.MapGroup("/api/favorites");
favorites.MapGet("/", () => recipes.Where(r => favoriteIds.Contains(r.Id)));
favorites.MapPost("/{id:int}", (int id) =>
{
    if (!recipes.Any(r => r.Id == id))
        return Results.NotFound(new { error = $"Recipe {id} not found" });
    if (!favoriteIds.Contains(id))
        favoriteIds.Add(id);
    return Results.NoContent();
});
favorites.MapDelete("/{id:int}", (int id) =>
{
    favoriteIds.Remove(id);
    return Results.NoContent();
});

app.Run();

Toutes les leçons de Minimal APIs