Teilaktualisierungen mit PATCH
Teil des Abschnitts REST-APIs der ASP.NET Core-Journey von Coddy. Lektion 4 von 20.
PATCH ändert nur die Felder, die der Body sendet. Damit du unterscheiden kannst, ob ein Feld ausgelassen oder gesetzt wurde, muss jede Eigenschaft des Patch-Datensatzes nullable sein: Ein fehlendes Feld wird an null gebunden.
record ProfilePatch(string? Name, string? City);
profiles[index] = profile with
{
Name = patch.Name ?? profile.Name,
City = patch.City ?? profile.City,
};with kopiert einen Datensatz und ändert die Eigenschaften, die du angibst. ?? behält den alten Wert bei, wenn der Patch null enthält. Ein bool? funktioniert genauso: false ist ein vom Client gesendeter Wert, und null bedeutet, dass nichts gesendet wurde. Daher verschiebt { "city": "Lyon" } das Profil und behält seinen Namen bei.
Aufgabe
EinfachErmögliche Clients, ein einzelnes Feld einer Aufgabe zu ändern, zum Beispiel sie als erledigt zu markieren, ohne den Titel erneut zu senden.
- Füge am Ende von
Program.csdie Deklarationrecord TaskPatch(string? Title, bool? Done);hinzu. - Ordne
PATCH /api/tasks/{id:int}mit einemint idund einemTaskPatch patchzu. GibResults.NotFound()zurück, wenn es keine Aufgabe mit dieser ID gibt. - Speichere andernfalls eine Kopie der Aufgabe, die mit
witherstellt wurde. Jede Eigenschaft übernimmt dabei den Wert des Patches oder behält den eigenen Wert der Aufgabe bei, wenn der Patchnullenthält. Gib die geänderte Aufgabe mitResults.Okzurück.
PATCH /api/tasks/1 mit { "done": true } gibt 200 und Folgendes zurück:
{ "id": 1, "title": "Write the project brief", "done": true }Probier es aus: Drücke „Ausführen“, wähle PATCH, den Pfad /api/tasks/1, den Body { "done": true } und „Senden“: Es erscheint die obige Antwort, wobei der Titel erhalten bleibt. Sende PATCH an /api/tasks/2 mit { "title": "Book the big room" }: Der neue Titel wird übernommen und "done": true bleibt erhalten. PATCH an /api/tasks/99 gibt 404 zurück.
Probier es selbst
var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();
var tasks = new List<TaskItem>
{
new(1, "Write the project brief", false),
new(2, "Book the meeting room", true),
new(3, "Send the invoice", false),
};
var nextId = 4;
app.MapGet("/api/tasks", () => tasks);
app.MapGet("/api/tasks/{id:int}", (int id) =>
{
var task = tasks.Find(t => t.Id == id);
return task is null ? Results.NotFound() : Results.Ok(task);
});
app.MapPost("/api/tasks", (TaskInput input) =>
{
var task = new TaskItem(nextId++, input.Title, input.Done);
tasks.Add(task);
return Results.Created($"/api/tasks/{task.Id}", task);
});
app.MapPut("/api/tasks/{id:int}", (int id, TaskInput input) =>
{
var index = tasks.FindIndex(t => t.Id == id);
if (index == -1) return Results.NotFound();
tasks[index] = new TaskItem(id, input.Title, input.Done);
return Results.Ok(tasks[index]);
});
app.Run();
record TaskItem(int Id, string Title, bool Done);
record TaskInput(string Title, bool Done);
Diese Lektion enthält ein kurzes Quiz. Starte die Lektion, um es zu beantworten und deinen Fortschritt zu speichern.
Alle Lektionen in REST-APIs
1Ressourcen und Verben
Ressourcen und URLsErstellen mit POST