This project is read-only.

Web API Documentation structure lacking

Topics: ASP.NET Web API
Jan 8, 2015 at 6:52 PM

I was setting up my web api documentation when I noticed that the help page model is only pulling the summary tag within the xml documentation.

I propose making a full documentation object model that would contain all that .net could offer from the xml documentation.

Think not only summary, but remarks, parameters, return types, "see ref", <example> etc.

And I'm only talking about putting this in the ApiDocumentation object (System.Web.Http.Description.ApiDocumentation object)
And replacing the property ".Documentation" from a string to an object or, at the very least a new property that has all the details.

I'm more than willing to attempt this. Wanted to get feedback from the greater community first before I go coding.

Ivan P.