API Dağıtımı
Coddy'nin ASP.NET Core Journey'sinin REST API'leri bölümünün bir parçası. Ders 20 / 20.
Burada API'n bir bağlantı noktası olmadan çalışır. Bir sunucuda app.Run(), ASP.NET Core'un yerleşik web sunucusu olan Kestrel'i başlatır; bu sunucu ASPNETCORE_URLS içindeki URL'leri, örneğin http://+:8080 adresini dinler. dotnet publish -c Release, bir sunucuya kopyalanacak bir klasör veya kapsayıcı imajı oluşturur. Azure App Service, nginx arkasındaki bir Linux sunucusu ve kapsayıcı platformlarının tümü bu çıktıyı çalıştırır.
Ayarlar ortam değişkenlerinden gelir, böylece tek bir derleme her yerde çalışır. ASPNETCORE_ENVIRONMENT=Production, geliştirici hata sayfasını kapatır ve Shop__PageSize=25, builder.Configuration["Shop:PageSize"] değerine ulaşır: iki alt çizgi, iki nokta üst üste yerine kullanılır. Gizli bilgileri koda değil, ortam değişkenlerine koy. Sunucular ayrıca bir sağlık denetimi URL'sini çağırır ve yanıt vermeyi durduran bir uygulamayı yeniden başlatır:
builder.Services.AddHealthChecks();
var app = builder.Build();
app.MapHealthChecks("/health");Görev
KolayGörev takip uygulamanız kullanıma hazır. Çalışır durumda olduğunu kontrol etmeleri için sunuculara bir URL verin.
Program.csdosyasında,builder.Build()satırından öncebuilder.Services.AddHealthChecks();ekleyin.app.Run();satırının üstüneapp.MapHealthChecks("/health");ekleyin.
GET /health, Healthy metniyle 200 yanıtı verir. Diğer her şey çalışmaya devam eder.
Deneyin: Çalıştır'a basın: sütun GET /health isteğini gönderir ve Healthy sonucunu gösterir. GET / gönderin: görevlerin bulunduğu sayfanız açılır. Buradan hiçbir şey dağıtılmaz; bir sunucuda aynı kod, kendisine verilen bağlantı noktasında yanıt verir.
Kendin dene
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);
Bu ders kısa bir quiz içerir. Soruları yanıtlamak ve ilerlemeni kaydetmek için derse başla.