Live data from Hacker News

ApiDoc - Inline Documentation for RESTful web APIs

apidocjs.com

1–6 of 6 posts

Re: ApiDoc - Inline Documentation for RESTful web APIs

#5

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.

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

Re: ApiDoc - Inline Documentation for RESTful web APIs

#6
post #5

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.

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

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/