משאבים וכתובות URL
חלק מהיחידה REST APIs במסלול ה-ASP.NET Core של Coddy. שיעור 1 מתוך 20.
תוכניות אחרות קוראות ל־API שלך, לכן כתובות ה־URL שלו צריכות להיות קלות לניחוש. רוב ממשקי ה־API לאינטרנט פועלים לפי סגנון שנקרא REST: כל כתובת URL מציינת משאב, דבר שה־API מאחסן, ושיטת HTTP מציינת מה לעשות איתו.
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הנתיבים מכילים שמות עצם, לעולם לא פעלים: עם /api/getInvoice?id=7, כל לקוח חייב ללמוד מילה חדשה לכל פעולה. לאוסף יש שם ברבים, ופריט יחיד הוא הנתיב של האוסף בתוספת המזהה שלו.
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} הוא פרמטר נתיב עם אילוץ: הוא מתאים למספרים שלמים בלבד, ולכן /api/invoices/abc אינו מתאים לאף נתיב ומחזיר 404. גם מזהה שאינו תואם לאף חשבונית מחזיר 404, באמצעות Results.NotFound().
אתגר
קלביחידה הזאת תבנה API למעקב אחר משימות. הוא מתחיל עם שלוש משימות ועם GET /api/tasks, שמחזיר את כולן. המשימות הן רשומות מסוג TaskItem, כי ל־.NET כבר יש טיפוס שנקרא Task. הוסף כתובת URL למשימה אחת.
- ב־
Program.cs, מתחת ל־GET /api/tasks, מפה אתGET /api/tasks/{id:int}. - מצא את המשימה שה־
Idשלה שווה ל־idבאמצעותtasks.Find, והחזר אותה באמצעותResults.Ok(task).GET /api/tasks/2מחזיר: - כשאין משימה עם המזהה הזה, החזר
Results.NotFound(): סטטוס 404 עם גוף ריק.
נסה זאת: לחץ על הרצה. העמודה שולחת GET /api/tasks ומציגה את שלוש המשימות. שלח GET /api/tasks/2: מתקבלים 200 והמשימה שלמעלה. שלח GET /api/tasks/99: מתקבל 404. שלח GET /api/tasks/abc: מתקבל גם 404, כי {id:int} מתאים למספרים בלבד.
נסו בעצמכם
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);
השיעור הזה כולל חידון קצר. התחילו את השיעור כדי לענות עליו ולעקוב אחרי ההתקדמות.
כל השיעורים ביחידה REST APIs
1משאבים ופעלים
משאבים וכתובות URLיצירה באמצעות POST