Ressourcen und URLs
Teil des Abschnitts REST-APIs der ASP.NET Core-Journey von Coddy. Lektion 1 von 20.
Andere Programme rufen deine API auf, daher sollten ihre URLs leicht zu erraten sein. Die meisten Web-APIs folgen einem Stil namens REST: Jede URL bezeichnet eine Ressource, also etwas, das die API speichert, und die HTTP-Methode gibt an, was damit zu tun ist.
GET /api/invoices the list of invoices
GET /api/invoices/7 invoice 7
POST /api/invoices add an invoice
DELETE /api/invoices/7 remove invoice 7Pfade enthalten Substantive, niemals Verben: Bei /api/getInvoice?id=7 muss jeder Client für jede Aktion ein neues Wort lernen. Die Sammlung hat einen Pluralnamen, und ein einzelnes Element entspricht dem Pfad der Sammlung plus seiner ID.
app.MapGet("/api/invoices/{id:int}", (int id) =>
{
var invoice = invoices.Find(i => i.Id == id);
return invoice is null ? Results.NotFound() : Results.Ok(invoice);
});{id:int} ist ein Routenparameter mit einer Einschränkung: Er akzeptiert nur ganze Zahlen. Daher entspricht /api/invoices/abc keiner Route und liefert 404 zurück. Auch eine ID, zu der keine Rechnung gehört, liefert über Results.NotFound() 404 zurück.
Aufgabe
EinfachIn diesem Abschnitt erstellst du eine Task-Tracker-API. Sie beginnt mit drei Aufgaben und GET /api/tasks, das sie alle zurückgibt. Die Aufgaben sind TaskItem-Datensätze, weil .NET bereits einen Typ namens Task hat. Füge die URL für eine einzelne Aufgabe hinzu.
- Ordne in
Program.csunterhalb vonGET /api/tasksGET /api/tasks/{id:int}zu. - Suche mit
tasks.Finddie Aufgabe, derenIdgleichidist, und gib sie mitResults.Ok(task)zurück.GET /api/tasks/2gibt Folgendes zurück:{ "id": 2, "title": "Book the meeting room", "done": true } - Wenn keine Aufgabe diese ID hat, gib
Results.NotFound()zurück: Status 404 mit einem leeren Antworttext.
Probiere es aus: Klicke auf „Ausführen“. Die Spalte sendet GET /api/tasks und zeigt die drei Aufgaben an. Sende GET /api/tasks/2: 200 und die Aufgabe von oben. Sende GET /api/tasks/99: 404. Sende auch GET /api/tasks/abc: 404, da {id:int} nur auf Zahlen zutrifft.
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),
};
app.MapGet("/api/tasks", () => tasks);
app.Run();
record TaskItem(int Id, 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