ApiDoc - Inline Documentation for RESTful web APIs (opens in new tab)

(apidocjs.com)

10 pointsapidoc13y ago5 comments

5 comments

5 comments · 2 top-level

chourobin13y ago· 2 in thread

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.

apidocOP13y ago

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 :)

sluukkonen13y ago

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/

rmoriz13y ago· 1 in thread

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

apidocOP13y ago

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

j / k navigate · click thread line to collapse

5 comments

5 comments · 2 top-level

chourobin13y ago· 2 in thread

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.

apidocOP13y ago

sluukkonen13y ago

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

rmoriz13y ago· 1 in thread

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

apidocOP13y ago

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

j / k navigate · click thread line to collapse