CODEWITHSUNDEEP
jsonwcfrest
Saturn K
Saturn K

Reputation: 2785

Are there any good automated tools to document REST APIs

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

Upvotes: 0

Views: 505

Answers (4)

TheodorosPloumis
TheodorosPloumis

Reputation: 2456

Try Swagger.

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

Upvotes: 0

Kuldeep Rana
Kuldeep Rana

Reputation: 76

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

Upvotes: 1

suing
suing

Reputation: 2878

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/

Upvotes: 2

Mike Parkhill
Mike Parkhill

Reputation: 5551

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/

Upvotes: 2

Related Questions