Kaynaklar ve URL'ler
Coddy'nin ASP.NET Core Journey'sinin REST API'leri bölümünün bir parçası. Ders 1 / 20.
Diğer programlar API'nizi çağırır, bu yüzden URL'lerinin tahmin edilmesi kolay olmalıdır. Çoğu web API'si REST adı verilen bir tarzı izler: her URL bir kaynağı, yani API'nin depoladığı bir şeyi adlandırır ve HTTP yöntemi bu kaynakla ne yapılacağını belirtir.
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 7Yol bölümleri isimler içerir, asla fiiller değil: /api/getInvoice?id=7 kullanıldığında, her istemcinin her eylem için yeni bir sözcük öğrenmesi gerekir. Koleksiyonun adı çoğuldur ve tek bir öğenin yolu, koleksiyonun yoluna öğenin kimliği eklenerek oluşturulur.
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}, bir kısıtlamaya sahip rota parametresidir: yalnızca tam sayılarla eşleşir; bu nedenle /api/invoices/abc hiçbir rotayla eşleşmez ve 404 yanıtı verir. Hiçbir faturayla eşleşmeyen bir kimlik de Results.NotFound() aracılığıyla 404 yanıtı verir.
Görev
KolayBu bölümde bir görev takip API'si oluşturuyorsun. API, üç görevle ve tüm görevleri döndüren GET /api/tasks uç noktasıyla başlar. Görevler TaskItem kayıtlarıdır; çünkü .NET'te zaten Task adlı bir tür vardır. Tek bir görev için URL ekle.
Program.csdosyasında,GET /api/taskssatırının altınaGET /api/tasks/{id:int}eşlemesini ekle.tasks.FindileIddeğeriiddeğerine eşit olan görevi bul veResults.Ok(task)ile döndür.GET /api/tasks/2şu yanıtı verir:{ "id": 2, "title": "Book the meeting room", "done": true }- Bu kimliğe sahip bir görev yoksa
Results.NotFound()döndür: durum kodu 404 ve boş bir gövde.
Deneyin: “Çalıştır” düğmesine bas. Sütun, GET /api/tasks isteğini gönderir ve üç görevi gösterir. GET /api/tasks/2 isteğini gönder: 200 ve yukarıdaki görev. GET /api/tasks/99 isteğini gönder: 404. GET /api/tasks/abc isteğini de gönder: bu da 404 döndürür, çünkü {id:int} yalnızca sayılarla eşleşir.
Kendin dene
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);
Bu ders kısa bir quiz içerir. Soruları yanıtlamak ve ilerlemeni kaydetmek için derse başla.
REST API'leri bölümündeki tüm dersler
1Kaynaklar ve Fiiller
Kaynaklar ve URL'lerPOST ile Oluşturma