Implementing Swashbuckle/Swagger with .net Core 2 API I am now receiving the 500 error when accessing swagger.json:
NotSupportedException: Ambiguous HTTP method for action - EBisAPI.Controllers._class.HandleError (EBisAPI). Actions require an explicit HttpMethod binding for Swagger
I have gone through all the controllers and see explicit routing on all the public methods of each controller. Is there a way to determine which method is throwing the ambiguous routing error?
This can occur when a method is declared public in a controller, but without REST attributes. Changing the method to protected may address the issue.
I have seen this kind of error before and usually the error message points to the culprit:
EBisAPI.Controllers._class.HandleError
I guess HandleError is a public method in your base class, right? Change it to protected and try again.
This is of course only one possible solution. If the method which is mentioned in the error message is part of an interface implementation, it doesn't work and you need to look at one of the other solutions.
[HttpGet] attribute. Oops.Similar to totonho's answer you can use
[ApiExplorerSettings(IgnoreApi=true)]
(From https://github.com/domaindrivendev/Swashbuckle/issues/153 )
The Clean way could be using data annotation [NonAction] instead to set your method as protected.
IActionFilter methods to protected was causing the following error: Severity Code Description Project File Line Suppression State Error CS0737 'OrderController' does not implement interface member 'IActionFilter.OnActionExecuting(ActionExecutingContext)'. 'OrderController.OnActionExecuting(ActionExecutingContext)' cannot implement an interface member because it is not public. However [NonAction] did the trick
[NonAction] to [Route("error")] [NonAction] [AllowAnonymous] public IActionResult Error() { ... } I get back a 404. ASP.NET Core cannot find my /error endpoint. Voting down.I solved this error by decorating the method mentioned in the error with the correct HTTP attribute. For exemple: [HttpGet]
This code throws error:
public object Get()
{
MongoDbContext dbContext = new MongoDbContext();
return new {
API = true,
Database = dbContext.Status()
};
}
This code works:
[HttpGet]
public object Get()
{
MongoDbContext dbContext = new MongoDbContext();
return new {
API = true,
Database = dbContext.Status()
};
}
As i mentioned at "Swashbuckle not creating swagger.json file" :
[HttpGet("xxx")],[HttpPost("xxx")] or ... instead of [Route("xxx")].[NonAction] Attribute.
[NoAction]. This Case is rarely used but maybe you need it in special situations that I haven't encountered yet. (like. using reflection to reflect over public methods or ... )[email protected]
I tried different solutions but what it worked for me was adding the route inside the attributes as stated above. I.E: [HttpPost("yourRoute/create")] one of the issues was that I have 2 get methods so I changed their names and added the route to the attributes as I said.
I Had the same problem, and was because i have done the override of the Ok() method ,returning an OkObjectResult. The solution was change it from public to protected
I was facing the same issue. For me the mistake was by default WeatherForecastController or any other class was inheriting from ControllerBase class. But when I created a new one, it inherited from Controller class.
So this conflicts between ControllerBase and Controller class was causing the issue.
Then inheriting the new Controller from ControllerBase class fixed the issue for me.
You can't inherit from both ControllerBase and Controller at the same time.
In my case I had a public method in my Rest Controller that was decorated with both HttpGet() and a Route(). I removed the Route() and this fixed plus the Swagger generated the proper route itself in the UI
In my case this method was throwing the error, weirdly enough it was the only action in the controller and there was only one controller in the Api.
[HttpPost(Name = "CreateUser", Order = 0)]
[SwaggerOperation(
Summary = "Endpoint to create a user in the system.",
Description = "",
Tags = new[] { Tag })
]
[Route("User/Create")]
public async Task<ActionResult<UserResponse>> HandleAsync(
[FromBody] CreateUserRequest request,
CancellationToken cancellationToken = default)
{
// Body
}
It turns out if you have these as seperate attributes it confuses Swagger.
[Route("User/Create")]
[HttpPost]
The fix is to combine them into one attribute.
[HttpPost("Membership/Create", Name = "CreatePerson", Order = 0)]
The completed fixed action looks like this.
[HttpPost("Membership/Create", Name = "CreatePerson", Order = 0)]
[SwaggerOperation(
Summary = "Endpoint to create a user in the system.",
Description = "",
Tags = new[] { Tag })
]
[Route("User/Create")]
public
