API 배포하기
Coddy ASP.NET Core 여정의 REST API 섹션에 포함된 레슨. 20개 중 20번째.
여기서는 API가 포트 없이 실행됩니다. 서버에서 app.Run()은 ASP.NET Core에 내장된 웹 서버인 Kestrel을 시작하며, ASPNETCORE_URLS에 지정된 URL(예: http://+:8080)에서 요청을 수신합니다. dotnet publish -c Release는 호스트나 컨테이너 이미지에 복사할 폴더를 빌드합니다. Azure App Service, nginx 뒤에 있는 Linux 서버, 컨테이너 플랫폼 모두 이 빌드 결과를 실행합니다.
설정은 환경 변수에서 가져오므로 한 번 빌드하면 어디서나 실행됩니다. ASPNETCORE_ENVIRONMENT=Production은 개발자 오류 페이지를 끄고, Shop__PageSize=25는 builder.Configuration["Shop:PageSize"]에 전달됩니다. 밑줄 두 개는 콜론을 나타냅니다. 비밀 정보는 환경 변수에 보관하고, 코드에는 절대 넣지 마세요. 호스트는 상태 확인 URL도 호출하며, 응답을 멈춘 앱을 다시 시작합니다.
builder.Services.AddHealthChecks();
var app = builder.Build();
app.MapHealthChecks("/health");챌린지
쉬움작업 추적기가 배포할 준비를 마쳤습니다. 호스트에서 서비스가 정상적으로 작동하는지 확인할 URL을 제공하세요.
Program.cs에서builder.Build()앞에builder.Services.AddHealthChecks();를 추가하세요.app.Run();위에app.MapHealthChecks("/health");를 추가하세요.
GET /health는 텍스트 Healthy와 함께 200 응답을 반환합니다. 나머지 기능도 계속 작동합니다.
직접 해 보세요: ‘실행’을 누르세요. 해당 열에서 GET /health 요청을 보내고 Healthy를 표시합니다. GET /을 보내면 작업 항목이 있는 페이지가 표시됩니다. 여기서는 아무것도 배포되지 않습니다. 호스트에서는 같은 코드가 할당된 포트에서 응답합니다.
직접 해보기
using System.ComponentModel.DataAnnotations;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddProblemDetails();
builder.Services.AddCors(options =>
{
options.AddPolicy("board", policy => policy
.WithOrigins("https://board.example.com")
.WithMethods("GET", "POST", "PUT", "PATCH", "DELETE")
.WithHeaders("Content-Type")
.WithExposedHeaders("X-Total-Count"));
});
var app = builder.Build();
app.UseExceptionHandler();
app.UseStatusCodePages();
app.UseCors("board");
app.UseDefaultFiles();
app.UseStaticFiles();
var tasks = new List<TaskItem>
{
new(1, "Write the project brief", false, 1),
new(2, "Book the meeting room", true, 3),
new(3, "Send the invoice", false),
};
var nextId = 4;
bool TitleTaken(string title, int exceptId) =>
tasks.Any(t => t.Id != exceptId && string.Equals(t.Title, title, StringComparison.OrdinalIgnoreCase));
app.MapGet("/api/tasks", (bool? done, string? search, int? priority, string? sort, HttpResponse response, int page = 1, int pageSize = 10) =>
{
var errors = new Dictionary<string, string[]>();
if (sort is not null && sort != "id" && sort != "title" && sort != "priority")
errors["sort"] = ["Sort by id, title or priority."];
if (priority is < 1 or > 3)
errors["priority"] = ["Priority is 1 to 3."];
if (page < 1)
errors["page"] = ["Page starts at 1."];
if (pageSize < 1 || pageSize > 50)
errors["pageSize"] = ["Page size is 1 to 50."];
if (errors.Count > 0) return Results.ValidationProblem(errors);
IEnumerable<TaskItem> result = tasks;
if (done is not null) result = result.Where(t => t.Done == done);
if (!string.IsNullOrWhiteSpace(search))
result = result.Where(t => t.Title.Contains(search, StringComparison.OrdinalIgnoreCase));
if (priority is not null) result = result.Where(t => t.Priority == priority);
if (sort == "title") result = result.OrderBy(t => t.Title);
if (sort == "priority") result = result.OrderBy(t => t.Priority);
var matching = result.ToList();
response.Headers["X-Total-Count"] = matching.Count.ToString();
return Results.Ok(matching.Skip((page - 1) * pageSize).Take(pageSize));
});
app.MapGet("/api/tasks/summary", () => new
{
total = tasks.Count,
done = tasks.Count(t => t.Done),
open = tasks.Count(t => !t.Done),
});
app.MapGet("/api/tasks/{id:int}", (int id) =>
{
var task = tasks.Find(t => t.Id == id);
return task is null ? Results.NotFound() : Results.Ok(task);
});
app.MapPost("/api/tasks", (TaskInput input) =>
{
var errors = Validation.Errors(input);
if (errors is not null) return Results.ValidationProblem(errors);
if (TitleTaken(input.Title, 0))
return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
var task = new TaskItem(nextId++, input.Title, input.Done, input.Priority);
tasks.Add(task);
return Results.Created($"/api/tasks/{task.Id}", task);
});
app.MapPut("/api/tasks/{id:int}", (int id, TaskInput input) =>
{
var errors = Validation.Errors(input);
if (errors is not null) return Results.ValidationProblem(errors);
var index = tasks.FindIndex(t => t.Id == id);
if (index == -1) return Results.NotFound();
if (TitleTaken(input.Title, id))
return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
tasks[index] = new TaskItem(id, input.Title, input.Done, input.Priority);
return Results.Ok(tasks[index]);
});
app.MapPatch("/api/tasks/{id:int}", (int id, TaskPatch patch) =>
{
var errors = Validation.Errors(patch);
if (errors is not null) return Results.ValidationProblem(errors);
var index = tasks.FindIndex(t => t.Id == id);
if (index == -1) return Results.NotFound();
if (patch.Title is not null && TitleTaken(patch.Title, id))
return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
var task = tasks[index];
tasks[index] = task with
{
Title = patch.Title ?? task.Title,
Done = patch.Done ?? task.Done,
Priority = patch.Priority ?? task.Priority,
};
return Results.Ok(tasks[index]);
});
app.MapDelete("/api/tasks/{id:int}", (int id) =>
{
var removed = tasks.RemoveAll(t => t.Id == id);
return removed == 0 ? Results.NotFound() : Results.NoContent();
});
app.MapDelete("/api/tasks", (bool? done) =>
{
if (done != true)
{
return Results.ValidationProblem(new Dictionary<string, string[]>
{
["done"] = ["Add ?done=true to delete the done tasks."],
});
}
tasks.RemoveAll(t => t.Done);
return Results.NoContent();
});
app.Run();
record TaskItem(int Id, string Title, bool Done, int Priority = 2);
record TaskInput(
[property: Required(ErrorMessage = "Title is required."), StringLength(80)] string Title,
bool Done,
[property: Range(1, 3)] int Priority = 2);
record TaskPatch(string? Title, bool? Done, [property: Range(1, 3)] int? Priority);
이 레슨에는 짧은 퀴즈가 포함되어 있습니다. 레슨을 시작해 문제를 풀고 진행 상황을 기록하세요.