WCF WebApi auto documentation

Topics: Web Api
Dec 26, 2011 at 10:33 PM
Edited Dec 26, 2011 at 10:34 PM

I've just created a WebApi REST site where my users "POST" a message to a URL.  The content of the request is a json formatted string of key value pairs.

I'm looking for the best way to document the requirements.

WCF 4.0 implements "Help" in the rest services (http://msdn.microsoft.com/en-us/library/ee230442.aspx)

But this requires hosting with "WebServiceHost".  With the "HttpServiceHostFactory" of WebAPI, I can find no way to utilize the "Help" documentation.  Also I'm unsure of how to programatically show the requirements of this json string.  That might be a discussion for another thread however.

I have tried Autodocs (http://autodocs.codeplex.com) but it doesnt seem to work with WebAPI either and is so new that there is little/no support.

Does WebApi have any built in way to do documentation or how have you built docs for your WebApi apps?