Ressources et URL
Fait partie de la section APIs REST du Journey ASP.NET Core de Coddy. Leçon 1 sur 20.
D’autres programmes appellent votre API, donc ses URL doivent être faciles à deviner. La plupart des API web suivent un style appelé REST : chaque URL désigne une ressource, un élément stocké par l’API, et la méthode HTTP indique quoi en faire.
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 7Les chemins contiennent des noms, jamais des verbes : avec /api/getInvoice?id=7, chaque client doit apprendre un nouveau mot pour chaque action. La collection porte un nom au pluriel, et un élément correspond au chemin de la collection suivi de son identifiant.
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} est un paramètre de route assorti d’une contrainte : il ne correspond qu’aux nombres entiers, donc /api/invoices/abc ne correspond à aucune route et renvoie 404. Un identifiant qui ne correspond à aucune facture renvoie également 404, via Results.NotFound().
Défi
FacileDans cette section, tu crées une API de suivi des tâches. Elle commence avec trois tâches et GET /api/tasks, qui les renvoie toutes. Les tâches sont des enregistrements TaskItem, car .NET possède déjà un type appelé Task. Ajoute l’URL d’une tâche.
- Dans
Program.cs, sousGET /api/tasks, mappeGET /api/tasks/{id:int}. - Trouve la tâche dont
Idest égal àidavectasks.Find, et renvoie-la avecResults.Ok(task).GET /api/tasks/2renvoie :{ "id": 2, "title": "Book the meeting room", "done": true } - Lorsqu’aucune tâche n’a cet identifiant, renvoie
Results.NotFound(): statut 404 avec un corps vide.
Essaie : appuie sur Exécuter. La colonne envoie GET /api/tasks et affiche les trois tâches. Envoie GET /api/tasks/2 : 200 et la tâche ci-dessus. Envoie GET /api/tasks/99 : 404. Envoie GET /api/tasks/abc : 404 également, car {id:int} ne correspond qu’aux nombres.
Essayez vous-même
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);
Cette leçon comprend un petit quiz. Commencez la leçon pour y répondre et suivre votre progression.
Toutes les leçons de APIs REST
1Ressources et verbes
Ressources et URLCréer avec POST2Validation et erreurs
Rejeter les entrées incorrectes