Web Api - Swagger documentation error 500

Question

When I access to the swagger url: http://localhost:28483/swagger/ui/index, it generates this error:

500 : undefined http://localhost:28483/swagger/docs/v1

Any ideas?

UPDATED: See this detail error in firebug:

Not supported by Swagger 2.0: Multiple operations
 with path 'api/BimModel' and method 'GET'. See the config setting - \"ResolveConflictingActions\" for
 a potential workaround

@CuongLe: That's everything I got in the browser. – Minh Nguyen Oct 06 '15 at 15:51 — Minh Nguyen, Oct 06 '15 at 15:51

score 11 · Accepted Answer · answered Feb 17 '16 at 17:43

Swagger might be considering two actions as one operation (like in the case of this common scenario)...

GET api/Products
GET api/Products/{id}

It seems you can use attribute routing to fix this and use these attributes above your actions so swagger will recognize them separately.

[Route("api/Products")]

[Route("api/Products/{id:guid}")]

score 9 · Answer 2 · answered Oct 07 '15 at 00:42

9

Have you tried enable this in you swagger config?

c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());

answered Oct 07 '15 at 00:42

Adi Widodo

93
5

2

While this probably resolves the error, the other actions won't show up then in swagger. – Evan Feb 17 '16 at 17:00

score 1 · Answer 3 · edited May 23 '17 at 12:09

1

In the controller, it got two different GET operations and it is disallowed by Swagger. I suggest to either have only single GET operation for each controller or modify the router in WebApiConfig

edited May 23 '17 at 12:09

Community

1
1

answered Oct 06 '15 at 16:41

Minh Nguyen

2,106
1
28
34

1

Unfortunately modification of the router in ApiConfig does not helps. Still got `Not supported by Swagger 2.0: Multiple operations with path...`. It looks like I have to create new controller for each get method or is there any other way how to force swagger to cooperate (some attributes,...)? – wolen Feb 05 '16 at 09:27

score 0 · Answer 4 · answered Nov 01 '16 at 16:07

I had the same issue when mixing attribute routing with default routes. When I removed the default route the problem went away. The downside is, without the default route defined, I had to add attribute routing to all my controllers.

So from my WebApiConfig I removed:

config.Routes.MapHttpRoute(
    name: "DefaultApi",
    routeTemplate: "{controller}/{id}",
    defaults: new { id = RouteParameter.Optional }
);

And added attribute routing to my controller:

[Route("Session")] // Added this attribute
public async Task<IHttpActionResult> Get()
...    
[Route("Session/{id}")] // Added this attribute
public async Task<IHttpActionResult> Get(int id)

In reality I use a [RoutePrefix("Session")] on my Controller and use [Route("")] on my methods, but the result should be the same.

score 0 · Answer 5 · answered Apr 04 '17 at 14:52

I was getting this error due to the parameter names not matching between the Attribute Routing statement and the method signature.

[HttpGet("{id}")]
public IActionResult Get(string deviceNumber){
...

After changing "{id}" to "{deviceNumber}" it fixed the error.

score -1 · Answer 6 · edited Oct 07 '18 at 06:47

-1

config.Routes.MapHttpRoute(
    name: "DefaultApi",
    routeTemplate: "api/{controller}/{action}/{id}",
    defaults: new { id = RouteParameter.Optional }
);

edited Oct 07 '18 at 06:47

Samuel Liew

76,741
107
159
260

answered Oct 06 '18 at 10:13

coco key

1

3

Hey and welcome to Stackoverflow! Please use English, as hardly anybody will be able to understand your answer. The idea of this site is that one person asks a question, another person answers it and the solution for the problem in question is documented for *everybody* with the same problem. So, if only a fraction of people understand your answer, it is kind of a waste ;) – Markus W Mahlberg Oct 06 '18 at 12:56

Web Api - Swagger documentation error 500

6 Answers6

Linked