Skip to main content

ASP.NET Core Swagger error - Conflicting method/path combination

After adding a new method to a controller, my OpenAPI(Swagger) endpoint started to complain with the following error message:

Conflicting method/path combination "POST api/Orders" for actions - eShopExample.Web.Controllers.OrdersController.CreateOrder (eShopExample),eShopExample.Web.Controllers.OrdersController.ProcessOrders (eShopExample). Actions require a unique method/path combination for Swagger/OpenAPI 3.0. Use ConflictingActionsResolver as a workaround

I find the error message itself not very insightful but taking a look at my OrdersController made it all clear:

public class OrderController: Controller
{
// POST api/order
[HttpPost]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<ActionResult> CreateOrder(OrderProductCommand command)
{
var order = await _orderService.OrderProduct(command);
await _publishEndpoint.Publish(new PlaceOrderMessage { OrderId = order.Id });
return Ok();
}
[HttpPost]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<ActionResult> ProcessOrders(ICollection<Guid> orderIds)
{
var serviceClient = _busControl.CreateServiceClient();
var requestClient = serviceClient.CreateRequestClient<ProcessOrdersJob>();
var response = await requestClient.GetResponse<JobSubmissionAccepted>(new ProcessOrdersJob
{
JobId = Guid.NewGuid(),
OrderIds = new List<Guid>(orderIds)
});
return Ok(response);
}
}
view raw OrderController.cs hosted with ā¤ by GitHub

The problem was that I had 2 methods that were both using attribute based routing(through the [HttpPost] attribute) but where resolved to the same URI; ā€œapi/ordersā€. To fix it I had to use an overload of the [HttpPost] attribute and specify an alternative URI:

[HttpPost("processorders")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<ActionResult> ProcessOrders(ICollection<Guid> orderIds)
{
var serviceClient = _busControl.CreateServiceClient();
var requestClient = serviceClient.CreateRequestClient<ProcessOrdersJob>();
var response = await requestClient.GetResponse<JobSubmissionAccepted>(new ProcessOrdersJob
{
JobId = Guid.NewGuid(),
OrderIds = new List<Guid>(orderIds)
});
return Ok(response);
}

Popular posts from this blog

Kubernetesā€“Limit your environmental impact

Reducing the carbon footprint and CO2 emission of our (cloud) workloads, is a responsibility of all of us. If you are running a Kubernetes cluster, have a look at Kube-Green . kube-green is a simple Kubernetes operator that automatically shuts down (some of) your pods when you don't need them. A single pod produces about 11 Kg CO2eq per year( here the calculation). Reason enough to give it a try! Installing kube-green in your cluster The easiest way to install the operator in your cluster is through kubectl. We first need to install a cert-manager: kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.5/cert-manager.yaml Remark: Wait a minute before you continue as it can take some time before the cert-manager is up & running inside your cluster. Now we can install the kube-green operator: kubectl apply -f https://github.com/kube-green/kube-green/releases/latest/download/kube-green.yaml Now in the namespace where we want t...

Azure DevOps/ GitHub emoji

Iā€™m really bad at remembering emojiā€™s. So here is cheat sheet with all emojiā€™s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.

DevToysā€“A swiss army knife for developers

As a developer there are a lot of small tasks you need to do as part of your coding, debugging and testing activities.  DevToys is an offline windows app that tries to help you with these tasks. Instead of using different websites you get a fully offline experience offering help for a large list of tasks. Many tools are available. Here is the current list: Converters JSON <> YAML Timestamp Number Base Cron Parser Encoders / Decoders HTML URL Base64 Text & Image GZip JWT Decoder Formatters JSON SQL XML Generators Hash (MD5, SHA1, SHA256, SHA512) UUID 1 and 4 Lorem Ipsum Checksum Text Escape / Unescape Inspector & Case Converter Regex Tester Text Comparer XML Validator Markdown Preview Graphic Col...