The Hydocs project

This demo showcases documentation for a simple MVC 6 application (REST API)


some REACT features

Scroll for more!



Demonstrates use of Microsoft ASP.NET Web API Help Page and the Swagger package for Visual Studio 2017 (Swashbuckle) for documentation generation. You will still need to write the XML comments in the code files, to substitute Microsoft's default texts. .

Built with Entity Framework 6, using the two tables ("Customers" and "Products") from the Adventure Works database, the samples are very basic and more enhancements are coming soon. Edit and Delete functions are disabled on purpose.


When playing with available features, hit "Try MVC"- button or the "MVC 5" menu item first, and not the List View demo on the Home page. This way you  will be able to observe that it takes a little longer time to fetch the results into  the MVC framework vs. Web Forms List Views,. The List Views use the Adworks Web API as Data Sources.


This is an ASP.NET 4.5, hybrid web application, where the MVC controllers are different from Web API controllers. An MVC controller uses the System.Web.MVC.Controller base class and a Web API controller uses the System.Web.Http.ApiController base class. In MVC 6 (.NET Core 1.0), there is only one Controller base class for both MVC and Web API controllers that is the Microsoft.AspNet.Mvc.Controller class.
I hope to convert the app,  demonstrate and document this, too, very soon. For now, I am using a combination of both Controller types.


1. (aka Tatiana K. Joergensen)

2. Best practices for writing XNL comments