Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Documenting /Designing ASP.NET Web API with Swagger

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?

like image 610
GilliVilla Avatar asked Dec 11 '22 03:12

GilliVilla


1 Answers

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.

like image 186
Xavier Egea Avatar answered Dec 31 '22 09:12

Xavier Egea