Documenting /Designing ASP.NET Web API with Swagger

Question

I have a functional Web API project. How can I retrofit it with minimal effort to a Swagger documentation/design like http://petstore.swagger.wordnik.com/

Is there a native Swagger like capability available for Web API itself?

Xavier Egea · Accepted Answer · 2014-10-12 01:47:24Z

13

For the ASP.NET Web API I recommend you "Swashbuckle". This implementation simplifies adding Swagger to any Web API project by following simple steps. Basically, you will only have to Install the Swashbuckle NuGet package and follow some easy instructions.

Taiseer Joudeh wrote the post "ASP.NET Web API Documentation using Swagger" about how to configure it.

Another popular implementation is Swagger.net, but last change was made 2 years ago, so it seems discontinued.

answered Oct 12, 2014 at 1:47

Xavier Egea

4,7633 gold badges27 silver badges39 bronze badges

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

Comments

Rico Suter · Accepted Answer · 2016-05-06 23:35:14Z

1

You can also use NSwag to generate Swagger specifications and client code for existing Web API controllers... There is a Windows GUI and command line tools to integrate the tools in your build chains...

edited May 6, 2016 at 23:35

answered Oct 29, 2015 at 22:05

Rico Suter

11.9k6 gold badges69 silver badges98 bronze badges

Comments

hcoverlambda · Accepted Answer · 2016-09-06 19:14:35Z

0

You might also try Swank. Automatically generates documentation, supports XML comments, markdown, emojis, coventions, etc: http://www.mikeobrien.net/swank/

answered Sep 6, 2016 at 19:14

hcoverlambda

1,3401 gold badge15 silver badges21 bronze badges

Collectives™ on Stack Overflow

Documenting /Designing ASP.NET Web API with Swagger

3 Answers 3

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related