C#•3y ago•

3 replies

❔ C# WebAPI - how to make a field 'optional' ?

I'm creating some WebAPI, I'm starting from a get, for the retrieval of users from a DB.
I'm using .NET 7.0 and EntityFramework.
The form that make the search request can take in input those fields:

Database ID

Database ID

User ID

User ID

FromDate

FromDate

ToDate

ToDate

Username

Username

All fields must be optional, obviously at least 1 should be sent.
I wrote some code:

[HttpGet("users")]
public IActionResult GetUsers(
    [FromQuery] int? dbId,
    [FromQuery] int? userId,
    [FromQuery] DateTime? fromDate,
    [FromQuery] DateTime? toDate,
    [FromQuery] string username)
{
    var query = _context.Users.AsQueryable();
    if (dbId.HasValue)
    {
        query = query.Where(d => d.dbId == dbId.Value);
    }
    if (userId.HasValue)
    {
        query = query.Where(d => d.userId == userId.Value);
    }
    if (fromDate.HasValue)
    {
        query = query.Where(d => d.registrationDate >= fromDate.Value);
    }
    if (toDate.HasValue)
    {
        query = query.Where(d => d.registrationDate <= toDate.Value);
    }
    if (!string.IsNullOrEmpty(username))
    {
        query = query.Where(d => d.username == username);
    }
    var users = query.ToList();
    return Ok(users);
}

[HttpGet("users")]
public IActionResult GetUsers(
    [FromQuery] int? dbId,
    [FromQuery] int? userId,
    [FromQuery] DateTime? fromDate,
    [FromQuery] DateTime? toDate,
    [FromQuery] string username)
{
    var query = _context.Users.AsQueryable();
    if (dbId.HasValue)
    {
        query = query.Where(d => d.dbId == dbId.Value);
    }
    if (userId.HasValue)
    {
        query = query.Where(d => d.userId == userId.Value);
    }
    if (fromDate.HasValue)
    {
        query = query.Where(d => d.registrationDate >= fromDate.Value);
    }
    if (toDate.HasValue)
    {
        query = query.Where(d => d.registrationDate <= toDate.Value);
    }
    if (!string.IsNullOrEmpty(username))
    {
        query = query.Where(d => d.username == username);
    }
    var users = query.ToList();
    return Ok(users);
}

As I understood, in that way EF understand how should it works, and the statement should works without bugs.
I think I'll only have to add a check at the beginning, for make sure that at least 1 field is sent.
Anyway when I test the API and I put only 1 field, for example

dbId

dbId

I get

Error 400

Error 400

as response,

The username field is required

The username field is required

I suppose that's why I never declared anywhere when the parameter is optional, and when not, since I just defined the code that have to be executed after a correct request is sent.
Browsing on the web I found some guides that suggest to add

[Required]

[Required]

tag on mandatory fields, inside the model.cs making the rest being optional, but this seems not working.
Other guides suggest to set all parameters to

null

null

by default, or at least setting the FrontEnd to work in this way.

❔ C# WebAPI - how to make a field 'optional' ?

I'm creating some WebAPI, I'm starting from a get, for the retrieval of users from a DB.
I'm using .NET 7.0 and EntityFramework.
The form that make the search request can take in input those fields:

Database ID

Database ID

User ID

User ID

FromDate

FromDate

ToDate

ToDate

Username

Username

All fields must be optional, obviously at least 1 should be sent.
I wrote some code:

[HttpGet("users")]
public IActionResult GetUsers(
    [FromQuery] int? dbId,
    [FromQuery] int? userId,
    [FromQuery] DateTime? fromDate,
    [FromQuery] DateTime? toDate,
    [FromQuery] string username)
{
    var query = _context.Users.AsQueryable();
    if (dbId.HasValue)
    {
        query = query.Where(d => d.dbId == dbId.Value);
    }
    if (userId.HasValue)
    {
        query = query.Where(d => d.userId == userId.Value);
    }
    if (fromDate.HasValue)
    {
        query = query.Where(d => d.registrationDate >= fromDate.Value);
    }
    if (toDate.HasValue)
    {
        query = query.Where(d => d.registrationDate <= toDate.Value);
    }
    if (!string.IsNullOrEmpty(username))
    {
        query = query.Where(d => d.username == username);
    }
    var users = query.ToList();
    return Ok(users);
}

[HttpGet("users")]
public IActionResult GetUsers(
    [FromQuery] int? dbId,
    [FromQuery] int? userId,
    [FromQuery] DateTime? fromDate,
    [FromQuery] DateTime? toDate,
    [FromQuery] string username)
{
    var query = _context.Users.AsQueryable();
    if (dbId.HasValue)
    {
        query = query.Where(d => d.dbId == dbId.Value);
    }
    if (userId.HasValue)
    {
        query = query.Where(d => d.userId == userId.Value);
    }
    if (fromDate.HasValue)
    {
        query = query.Where(d => d.registrationDate >= fromDate.Value);
    }
    if (toDate.HasValue)
    {
        query = query.Where(d => d.registrationDate <= toDate.Value);
    }
    if (!string.IsNullOrEmpty(username))
    {
        query = query.Where(d => d.username == username);
    }
    var users = query.ToList();
    return Ok(users);
}

dbId

dbId

I get

Error 400

Error 400

as response,

The username field is required

The username field is required

[Required]

[Required]

tag on mandatory fields, inside the model.cs making the rest being optional, but this seems not working.
Other guides suggest to set all parameters to

null

null

by default, or at least setting the FrontEnd to work in this way.

❔ C# WebAPI - how to make a field 'optional' ?

❔ C# WebAPI - how to make a field 'optional' ?

Similar Threads

Similar Threads

Similar Threads