Problem Details
Coddy'nin ASP.NET Core Journey'sinin REST API'leri bölümünün bir parçası. Ders 8 / 20.
Boş bir 404 yanıt gövdesi, istemciyi neyin yanlış gittiğini tahmin etmeye bırakır. Problem details (RFC 9457), bir hata için standart JSON biçimidir ve application/problem+json içerik türüyle gönderilir. 400 yanıtların zaten bu biçimi kullanıyor. Bir sipariş API'sinde üç satır, her hataya aynı biçimi verir:
builder.Services.AddProblemDetails();
var app = builder.Build();
app.UseExceptionHandler();
app.UseStatusCodePages();Artık, bulunmayan bir sipariş için GET /api/orders/7 isteği şu 404 yanıtını verir:
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
"title": "Not Found", "status": 404,
"traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00" }AddProblemDetails, bu biçimi yazan hizmeti kaydeder. UseStatusCodePages, Results.NotFound() yanıtından veya rotası olmayan bir yoldan gelenler dâhil, gövdesi olmayan her hata yanıtına bir problem gövdesi ekler. UseExceptionHandler, yakalanmamış bir istisnayı 500 problemine dönüştürür. traceId her istekte yenidir; yanıtı sunucunun günlükleriyle ilişkilendirir.
Görev
KolayGörev takipçisinin hatalarını tek bir biçime sok; böylece istemci her hatayı aynı şekilde okur.
Program.csiçinde,builder.Build()satırından önceki satırabuilder.Services.AddProblemDetails();ekle.builder.Build()satırının hemen ardından, herhangi bir uç noktadan önceapp.UseExceptionHandler();ve sonraapp.UseStatusCodePages();ekle.
Başka hiçbir şeyi değiştirme: uç noktaların Results.NotFound() yanıtını vermeye devam etsin; gövdeyi ara katman yazılımı doldurur. GET /api/tasks/99 böylece 404 durum koduyla, application/problem+json içerik türünde ve şu yanıtı verir:
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5", "title": "Not Found", "status": 404, "traceId": "..." }Deneyin: Çalıştır'a basın ve GET /api/tasks/99 isteğini gönderin: yukarıdaki 404 yanıtını alırsınız. Hiçbir rotası olmayan bir yol olan GET /api/projects isteğini gönderin: aynı biçimde yanıt alırsınız. /api/tasks adresine POST ile { "title": "" } gönderin: 400 yanıtınız errors alanını korur ve bir traceId kazanır.
Kendin dene
using System.ComponentModel.DataAnnotations;
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),
};
var nextId = 4;
app.MapGet("/api/tasks", () => tasks);
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);
var task = new TaskItem(nextId++, input.Title, input.Done);
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();
tasks[index] = new TaskItem(id, input.Title, input.Done);
return Results.Ok(tasks[index]);
});
app.MapPatch("/api/tasks/{id:int}", (int id, TaskPatch patch) =>
{
var index = tasks.FindIndex(t => t.Id == id);
if (index == -1) return Results.NotFound();
var task = tasks[index];
tasks[index] = task with
{
Title = patch.Title ?? task.Title,
Done = patch.Done ?? task.Done,
};
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.Run();
record TaskItem(int Id, string Title, bool Done);
record TaskInput(
[property: Required(ErrorMessage = "Title is required."), StringLength(80)] string Title,
bool Done);
record TaskPatch(string? Title, bool? Done);
Bu ders kısa bir quiz içerir. Soruları yanıtlamak ve ilerlemeni kaydetmek için derse başla.