ApiDoc - Inline Documentation for RESTful web APIs

Posted by apidoc on Sunday April 21, 2013 @06:14AM
from the apidocjs.com dept.

( 5 comments | 10 points | on HN )

Re:ApiDoc - Inline Documentation for RESTful web APIs by rmoriz on Sunday April 21, 2013 @07:17AM (#5584539)

Is this only for JavaScript source? I miss the interactivity e.g. available in https://developers.helloreverb.com/swagger/

[ Parent | on HN ]

Re:ApiDoc - Inline Documentation for RESTful web APIs by apidoc on Sunday April 21, 2013 @08:09AM (#5584608)

You can use it on any source, but we write it in JavaScript with NodeJs.

[ Parent | on HN ]

Re:ApiDoc - Inline Documentation for RESTful web APIs by chourobin on Sunday April 21, 2013 @08:20AM (#5584626)

Great work! This is something I have been looking for. It would be nice if you listed some of the alternatives out there as well.

[ Parent | on HN ]

Re:ApiDoc - Inline Documentation for RESTful web APIs by apidoc on Sunday April 21, 2013 @08:28AM (#5584643)

Hope some people write here some alternatives, i always watch for good tools too. Most of the documentation tools document the code itself (like JSDoc), but i did not found many for RESTful Api documentation, thats why i start the project :)

[ Parent | on HN ]

Re:ApiDoc - Inline Documentation for RESTful web APIs by sluukkonen on Sunday April 21, 2013 @09:09AM (#5584721)

One such tool is Swagger [1]. The nice thing about it is that it can automatically write you a client as well. There are client implementations for many programming languages, such as Java, Scala, Clojure, Ruby, Python, PHP, Javascript and C#.

[1] https://developers.helloreverb.com/swagger/

[ Parent | on HN ]