Detail Masalah
Termasuk bagian REST API dalam perjalanan ASP.NET Core di Coddy. Pelajaran 8 dari 20.
Body 404 yang kosong membuat client menebak-nebak apa yang salah. Problem details (RFC 9457) adalah format JSON standar untuk error, yang dikirim dengan tipe konten application/problem+json. Respons 400-mu sudah menggunakannya. Dalam API orders, tiga baris membuat semua error memiliki format yang sama:
builder.Services.AddProblemDetails();
var app = builder.Build();
app.UseExceptionHandler();
app.UseStatusCodePages();Sekarang, GET /api/orders/7 untuk order yang tidak ditemukan memberikan respons 404 dengan:
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
"title": "Not Found", "status": 404,
"traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00" }AddProblemDetails mendaftarkan layanan yang menulis format tersebut. UseStatusCodePages memberikan body problem pada setiap respons error yang belum memilikinya, baik dari Results.NotFound() maupun dari path tanpa route. UseExceptionHandler mengubah exception yang tidak tertangani menjadi problem 500. traceId berbeda pada setiap request, dan menghubungkan respons dengan log server.
Tantangan
MudahSamakan bentuk error pada pelacak tugas agar client membaca setiap kegagalan dengan cara yang sama.
- Di
Program.cs, pada baris sebelumbuilder.Build(), tambahkanbuilder.Services.AddProblemDetails(); - Tepat setelah
builder.Build(), tambahkanapp.UseExceptionHandler();laluapp.UseStatusCodePages();, sebelum endpoint apa pun.
Jangan ubah hal lain: endpoint-mu tetap mengembalikan Results.NotFound(), dan middleware mengisi body-nya. GET /api/tasks/99 kemudian mengembalikan 404 dengan tipe konten application/problem+json dan:
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5", "title": "Not Found", "status": 404, "traceId": "..." }Coba: tekan Jalankan dan kirim GET /api/tasks/99: hasilnya 404 seperti di atas. Kirim GET /api/projects, jalur yang tidak memiliki route: bentuknya sama. Kirim POST { "title": "" } ke /api/tasks: respons 400-mu tetap memiliki errors, dan mendapat tambahan traceId.
Coba sendiri
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);
Pelajaran ini berisi kuis singkat. Mulai pelajarannya untuk menjawab kuis dan melacak progresmu.