Zasoby i adresy URL
Część sekcji API REST ścieżki ASP.NET Core w Coddy. Lekcja 1 z 20.
Inne programy korzystają z Twojego API, dlatego jego adresy URL powinny być łatwe do przewidzenia. Większość internetowych interfejsów API korzysta ze stylu o nazwie REST: każdy adres URL określa zasób, czyli element przechowywany przez API, a metoda HTTP wskazuje, co należy z nim zrobić.
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 7Ścieżki zawierają rzeczowniki, nigdy czasowniki: w przypadku /api/getInvoice?id=7 każdy klient musi poznać nowe słowo dla każdej czynności. Kolekcja ma nazwę w liczbie mnogiej, a ścieżka pojedynczego elementu to ścieżka kolekcji z dodanym jego identyfikatorem.
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} to parametr ścieżki z ograniczeniem: dopasowuje tylko liczby całkowite, więc /api/invoices/abc nie pasuje do żadnej ścieżki, a odpowiedzią jest kod 404. Identyfikator, któremu nie odpowiada żadna faktura, również skutkuje kodem 404 za pośrednictwem Results.NotFound().
Wyzwanie
ŁatwyW tej sekcji zbudujesz API do śledzenia zadań. Zaczyna się ono od trzech zadań i GET /api/tasks, które zwraca je wszystkie. Zadania są rekordami TaskItem, ponieważ .NET ma już typ o nazwie Task. Dodaj adres URL pojedynczego zadania.
- W pliku
Program.cs, poniżejGET /api/tasks, zmapujGET /api/tasks/{id:int}. - Znajdź zadanie, którego
Idjest równeid, za pomocątasks.Findi zwróć je za pomocąResults.Ok(task). ŻądanieGET /api/tasks/2zwraca:{ "id": 2, "title": "Book the meeting room", "done": true } - Gdy żadne zadanie nie ma takiego identyfikatora, zwróć
Results.NotFound(): status 404 z pustym ciałem odpowiedzi.
Wypróbuj: naciśnij Uruchom. Kolumna wysyła żądanie GET /api/tasks i wyświetla trzy zadania. Wyślij żądanie GET /api/tasks/2: 200 i zadanie pokazane powyżej. Wyślij żądanie GET /api/tasks/99: 404. Wyślij żądanie GET /api/tasks/abc: również 404, ponieważ {id:int} pasuje tylko do liczb.
Spróbuj swoich sił
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);
Ta lekcja zawiera krótki quiz. Zacznij lekcję, żeby na niego odpowiedzieć i śledzić swoje postępy.
Wszystkie lekcje w sekcji API REST
1Zasoby i metody HTTP
Zasoby i adresy URLTworzenie za pomocą POST