.NET 6 - How to use Optional Route Parameters ASP.NET Core WEB API?

Question

I have created an ASP.NET Core WEB API template project and targeting .NET 6.

I have the following controller code,

using System.Text.Json;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;

namespace abc.Controllers;

[Authorize]
[ApiController]
[Route("api/v{version:apiVersion}/customers/{customerId?}/something")]
public class XYZController : ControllerBase
{
    [HttpPost]
    public string PostAsync(int customerId)
    {
        return JsonSerializer.Serialize("Sample");
    }
}

In the Swagger UI, I still see customerId as required,

How should I address this?

This is a common problem found in swagger (see stackoverflow.com/questions/46510901/… and other places). The quickest fix would be to remove {customerId} from your route. Swagger will pick it up from the method signature but it wont be mandatory. — Yossi Sternlicht
– Yossi Sternlicht, Commented Aug 11, 2022 at 22:44

Serge · Accepted Answer · 2022-08-14 18:36:06Z

6

you don't use route input parameters for a controller route, only for an action

[Route("~/api/v{version:apiVersion}/customers")]
public class XYZController : ControllerBase
{
    [HttpPost("something")] 
    [HttpPost("{customerId}/something")] 
    public string PostAsync(int? customerId)
    {
        return JsonSerializer.Serialize("Sample optional");
    }
}

edited Aug 14, 2022 at 18:36

answered Aug 12, 2022 at 22:39

Serge

44.4k4 gold badges26 silver badges53 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

tRuEsAtM Over a year ago

Does it make customerId parameter optional?

Serge Over a year ago

@tRuEsAtM you can make it optional for an action where it is needed.

tRuEsAtM Over a year ago

endpoints.MapControllers() require me add UseRouting() and it is messing up my endpoint URL to https://localhost:7075/rc/api/v1/customers/Post/1 I want to have a single endpoint/method which takes an optional param, and my route should remain unchanged. For e.g. using postman https://localhost:7075/rc/api/v1/customers/1/something and https://localhost:7075/rc/api/v1/customers/something I want to achieve the same results. Is it possible?

Serge Over a year ago

@tRuEsAtM You have to update your question. Now you are asking about completely different thing. As I understand now you want to place id in the middle of the url, not at the end.

tRuEsAtM Over a year ago

My bad, I updated the question, yeah I need the Id in the middle.

|

Collectives™ on Stack Overflow

.NET 6 - How to use Optional Route Parameters ASP.NET Core WEB API?

1 Answer 1

6 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

6 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related