Making Parameters Optional with Nullable Types

Welcome to this lesson on advanced model binding in ASP.NET Core Minimal APIs. In our previous lessons, we covered the basics of binding simple types, such as query and route parameters, as well as complex types from the request body. In this lesson, we'll go beyond the basics and explore the concept of making parameters optional, allowing more flexible API interactions without triggering errors when parameters are missing.

Up until now, all the parameters we've bound—whether they are route values, query parameters, or parts of the request body—were required by default. If any of these parameters were missing in the request, the server would return a 400 Bad Request error. Here's an example to illustrate this:

app.MapGet("/todos/{id}", (int id) =>
{
    var todo = todos.FirstOrDefault(t => t.Id == id);
    return todo != null ? Results.Ok(todo) : Results.NotFound("Todo not found");
});

In this example, the id route parameter is mandatory. If you make a request without specifying the id, the server will respond with a 400 error, indicating a bad request due to missing parameters.

As a recap from the previous course "Routing in ASP.NET Core," you learned how to make a route parameter optional. Here’s a quick refresher:

app.MapGet("/todos/{id?}", (int? id) =>
{
    if (id.HasValue) 
    {
        var todo = todos.FirstOrDefault(t => t.Id == id.Value);
        return todo != null ? Results.Ok(todo) : Results.NotFound("Todo not found");
    }
    return Results.Ok(todos);
});

In this example, the route parameter id is now optional. If id is not provided, the endpoint responds with all Todo items.

Next, consider making a query parameter optional. The approach is similar to that of route parameters:

app.MapGet("/todos", (int? id) =>
{
    if (id.HasValue) 
    {
        var todo = todos.FirstOrDefault(t => t.Id == id.Value);
        return todo != null ? Results.Ok(todo) : Results.NotFound("Todo not found");
    }
    return Results.Ok(todos);
});

Here, the query parameter id is optional. The server checks if id has a value and performs the corresponding action. If id is omitted, it returns all Todo items.

Finally, let's look at how to handle optional parameters within the request body. Similar to route and query parameters, you can use nullable types for body parameters as well:

app.MapPost("/todos", ([FromBody] TodoItem? todo) =>
{
    if (todo != null) 
    {
        return Results.Ok($"Received Todo: {todo.Title}");
    }
    return Results.BadRequest("No Todo received");
});

In this case, the [FromBody] attribute is used to bind the todo object from the request body, and the parameter is made nullable. If the request body is empty, the action gracefully handles it by returning a 400 Bad Request response.

In this lesson, we explored how to make parameters optional in ASP.NET Core Minimal APIs. By using nullable types, you can create more flexible and adaptable API endpoints, allowing for a broader range of valid requests and smoother client-server interactions. This approach will help enhance the overall API usability and user experience.