Menu
CoddyTech

Task Priorities

Part of the REST APIs section of Coddy's ASP.NET Core journey. Lesson 14 of 20.

This chapter is a project: you add a feature across the API with what you have learned. Some tasks are urgent, so each task gets a priority: 1 is high, 2 normal, 3 low.

record Seat(int Row, [property: Range(1, 40)] int Number = 1);

[Range(1, 40)] refuses a number outside 1 to 40 with the message The field Number must be between 1 and 40. A default value in a positional record (= 1) is what a JSON body that leaves the field out gets. On a nullable property, Range lets null through, which suits a PATCH.

challenge icon

Challenge

Medium

Give every task a priority from 1 (high) to 3 (low). Keep everything you built: every endpoint keeps working as before.

  1. Add int Priority = 2 as the last property of TaskItem. Give task 1 priority 1 and task 2 priority 3; task 3 keeps the default, 2.
  2. Add [property: Range(1, 3)] int Priority = 2 as the last property of TaskInput, and pass input.Priority to the new TaskItem in POST and PUT.
  3. Add [property: Range(1, 3)] int? Priority to TaskPatch. At the start of PATCH, check the patch with Validation.Errors(patch) and answer Results.ValidationProblem when it finds errors. Copy the priority in the with, like the other fields.

Every task now carries its priority: { "id": 1, "title": "Write the project brief", "done": false, "priority": 1 }. A priority of 5 answers 400 with "errors": { "priority": ["The field Priority must be between 1 and 3."] }.

Try it: press Run: every task in the list has a priority. POST { "title": "Order new chairs" }: priority 2. POST { "title": "Fix the printer", "priority": 5 }: 400. PATCH /api/tasks/3 with { "priority": 1 }: task 3 becomes urgent and keeps its title.

Try it yourself

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, 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")
        errors["sort"] = ["Sort by id or title."];
    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 (sort == "title") result = result.OrderBy(t => t.Title);

    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/{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);

All lessons in REST APIs