리소스와 URL
Coddy ASP.NET Core 여정의 REST API 섹션에 포함된 레슨. 20개 중 1번째.
다른 프로그램이 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처럼 작성하면 클라이언트마다 각 작업에 해당하는 새 단어를 배워야 합니다. 컬렉션에는 복수형 이름을 사용하고, 항목 하나는 컬렉션의 경로에 해당 항목의 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}는 제약 조건이 있는 경로 매개변수입니다. 정수에만 일치하므로 /api/invoices/abc는 어떤 경로에도 일치하지 않아 404를 반환합니다. 어떤 송장에도 해당하지 않는 id 역시 Results.NotFound()를 통해 404를 반환합니다.
챌린지
쉬움이 섹션에서는 작업 추적기 API를 만듭니다. API에는 처음에 작업 세 개가 있고, GET /api/tasks는 작업을 모두 반환합니다. 작업은 TaskItem 레코드입니다. .NET에 이미 Task라는 형식이 있기 때문입니다. 작업 하나의 URL을 추가하세요.
Program.cs에서GET /api/tasks아래에GET /api/tasks/{id:int}를 매핑하세요.tasks.Find를 사용해Id가id와 같은 작업을 찾고,Results.Ok(task)로 반환하세요.GET /api/tasks/2는 다음을 반환합니다:{ "id": 2, "title": "Book the meeting room", "done": true }- 해당 id를 가진 작업이 없으면
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);
이 레슨에는 짧은 퀴즈가 포함되어 있습니다. 레슨을 시작해 문제를 풀고 진행 상황을 기록하세요.