If you are looking for a better alternative to using ASP.NET Web API Help, then you will definitely want to check out Swashbuckle for Swagger: https://www.nuget.org/packages/swashbuckle
https://github.com/domaindrivendev/Swashbuckle
Swashbuckle for Swagger provides significantly more Web API Help functionality than is provided by ASP.NET Web API Help.
For example, this is the ASP.NET Web API Help even with XML Comments in place:
However, when you add the Swashbuckle NuGet package to your ASP.NET Web API Web Application (with XML Comments enabled in SwaggerConfig.cs), you get this instead:
You will immediately notice that much like ASMX and WCF Services, you can directly test the ASP.NET Web API services from the Swashbuckle Help!
How cool is that??
For additional guidance on incorporating Swashbuckle/Swagger into your ASP.NET Web API Web Application, you can check out this article: http://www.codeproject.com/Articles/1078249/RESTful-Web-API-Help-Documentation-using-Swagger-U
https://github.com/domaindrivendev/Swashbuckle
Swashbuckle for Swagger provides significantly more Web API Help functionality than is provided by ASP.NET Web API Help.
For example, this is the ASP.NET Web API Help even with XML Comments in place:
However, when you add the Swashbuckle NuGet package to your ASP.NET Web API Web Application (with XML Comments enabled in SwaggerConfig.cs), you get this instead:
You will immediately notice that much like ASMX and WCF Services, you can directly test the ASP.NET Web API services from the Swashbuckle Help!
How cool is that??
For additional guidance on incorporating Swashbuckle/Swagger into your ASP.NET Web API Web Application, you can check out this article: http://www.codeproject.com/Articles/1078249/RESTful-Web-API-Help-Documentation-using-Swagger-U
No comments:
Post a Comment