0

Are there any automated tools that I can point to our WCF REST API and have it create documentation (preferably with samples)?

Saturn K
  • 2,705
  • 4
  • 26
  • 38
  • Not an answer to your question as you are looking for .net solution, but for java, this works great for me: http://enunciate.codehaus.org – jayraynet Sep 23 '12 at 02:15

4 Answers4

2

Take a look at the Sandcastle project. We're using it to produce MSDN or JavaDoc style Html pages based on the ///<summary> tags on our public C# members.

http://sandcastle.codeplex.com/

Mike Parkhill
  • 5,511
  • 1
  • 28
  • 38
2

Are you using Web Api? If so the following link could help

http://blogs.msdn.com/b/yaohuang1/archive/2012/05/13/asp-net-web-api-introducing-iapiexplorer-apiexplorer.aspx

Here is something on general documentation. http://blog.programmableweb.com/2010/08/12/web-api-documentation-best-practices/

suing
  • 2,808
  • 2
  • 16
  • 18
1

You can also use Rest Assured library. For demo with sample script, refer to http://artoftesting.com/automationTesting/restAPIAutomationGetRequest.html

0

Try Swagger.

Maybe the best open source solution at the moment. It has a lot of tools available for REST API documentation and more.

TheodorosPloumis
  • 2,396
  • 1
  • 17
  • 31