Adding new method to controller makes swagger give 500 error

Question

It's been a while since I made an API. Now I was looking at it again and I tried to simply add a get method to the WeatherForecastController. But I keep getting a swagger error after adding it. The method looks very similar to the existing method. only that this one uses a parameter. But after adding it I keep getting an error in my browser. and I'm not sure why. I haven't done this in a very long time. And I never used swagger before.

Note that I simply created the project and added the method that is all I did. This is the browser error.

Maybe, as detailed in this answer, the missing information here is: you should not use the placeholder Name. Remove the placeholder and use the constructor with the string only or use the Template placeholder. Take care about the parameter amount, though. If you don't insert it inside the template, you'll only be able to pass it through QueryString. — Alielson Piffer
– Alielson Piffer, Commented Jun 22, 2023 at 21:25

Michael · Accepted Answer · 2023-01-10 06:53:19Z

7

Change [Route("[controller]")] to [Route("[controller]/[action]")]

answered Jan 10, 2023 at 6:53

Michael

2,9753 gold badges29 silver badges31 bronze badges

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

Comments

bugrakosen · Accepted Answer · 2022-09-04 09:17:06Z

Try this;

[HttpGet("GetWeatherForecast")]
public IEnumerable<WeatherForecast> Get()
{
    return Enumerable.Range(1, 5).Select(index => new WeatherForecast
    {
        Date = DateTime.Now.AddDays(index),
        TemperatureC = Random.Shared.Next(-20, 55),
        Summary = Summaries[Random.Shared.Next(Summaries.Length)]
    })
    .ToArray();
}

[HttpGet("GetNumberOfForecasts/{amount}")]
public IEnumerable<WeatherForecast> GetAmount(int amount)
{
    return Enumerable.Range(1, amount).Select(index => new WeatherForecast
    {
        Date = DateTime.Now.AddDays(index),
        TemperatureC = Random.Shared.Next(-20, 55),
        Summary = Summaries[Random.Shared.Next(Summaries.Length)]
    })
    .ToArray();
}

Sydney_dev · Accepted Answer · 2022-09-04 12:33:35Z

2

Just for future reference.

Step 1:-> Open your dev tools, or just F12.

      Then open the network tab, and refresh your page.

Step 2:> Click on the swagger call and click on the response tab.

You will see your error:

Swashbuckle.AspNetCore.SwaggerGen.SwaggerGeneratorException: Conflicting method/path combination "GET WeatherForecast" for actions - WebApplication1.Controllers.WeatherForecastController.Get (WebApplication1),WebApplication1.Controllers.WeatherForecastController.GetAmount (WebApplication1). Actions require a unique method/path combination for Swagger/OpenAPI 3.0. Use ConflictingActionsResolver as a workaround

Try routing like this

Results

answered Sep 4, 2022 at 12:33

Sydney_dev

1,4242 gold badges18 silver badges26 bronze badges

Comments

shivanand s gaddi · Accepted Answer · 2023-08-07 07:36:50Z

1

I resolved this issue by adding route as below.

[Route("[controller]/[action]")] [! Redefine the route with respect to action.]1

answered Aug 7, 2023 at 7:36

shivanand s gaddi

385 bronze badges

Collectives™ on Stack Overflow

Adding new method to controller makes swagger give 500 error

4 Answers 4

Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related