Menu
CoddyTech

Pengurutan

Termasuk bagian REST API dalam perjalanan ASP.NET Core di Coddy. Pelajaran 12 dari 20.

Parameter sort memungkinkan client memilih urutan: GET /api/products?sort=price. Terima hanya urutan yang kamu dukung, dan berikan respons 400 untuk nilai lainnya, sehingga kesalahan ketik seperti sort=prise dilaporkan, bukan diabaikan.

var errors = new Dictionary<string, string[]>();
if (sort is not null && sort != "name" && sort != "price")
    errors["sort"] = ["Sort by name or price."];
if (errors.Count > 0) return Results.ValidationProblem(errors);

if (sort == "price") result = result.OrderBy(p => p.Price);

OrderBy mengembalikan sequence baru yang sudah diurutkan dan tidak mengubah list. products.Sort(...) akan mengurutkan ulang list yang tersimpan itu sendiri, sehingga semua respons berikutnya juga akan menggunakan urutan baru. Mengumpulkan error dalam satu dictionary memungkinkan permintaan dengan beberapa kesalahan mendapatkan informasi tentang semuanya sekaligus.

challenge icon

Tantangan

Mudah

Biarkan client mengurutkan task berdasarkan judul.

  1. Beri lambda GET /api/tasks parameter ketiga, string? sort.
  2. Di awal lambda, kumpulkan error dalam sebuah dictionary. Jika sort bukan null, id, atau title, tambahkan Sort by id or title. di bawah sort, lalu berikan jawaban Results.ValidationProblem(errors) jika dictionary berisi item.
  3. Setelah filter diterapkan, jika sort adalah title, urutkan hasil berdasarkan judul dengan OrderBy. Tanpa sort, atau dengan sort=id, task tetap dalam urutan id.

GET /api/tasks?sort=title memberikan task 2, 3, dan 1: Book, Send, Write.

Coba: tekan Jalankan dan kirim GET /api/tasks?sort=title: urutannya seperti di atas. Kirim GET /api/tasks: urutannya kembali berdasarkan id. Kirim GET /api/tasks?sort=size: 400 dengan "errors": { "sort": ["Sort by id or title."] }. Kirim GET /api/tasks?done=false&sort=title: task 3 dan 1.

Coba sendiri

using System.ComponentModel.DataAnnotations;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddProblemDetails();
var app = builder.Build();

app.UseExceptionHandler();
app.UseStatusCodePages();

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;

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) =>
{
    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));
    return Results.Ok(result);
});

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);
    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);
    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();
    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,
    };
    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);

Semua pelajaran di REST API