Swagger

Does anyone know how this compares to wordnik's Swagger [1] ? I think Swagger is incredible, would love to see more API tools which promote good habits and make it easy to be beautiful. [1] https://developers.helloreverb.com/swagger/

I think Swagger [1,2] is similar, which I am currently using, via node/restify. Awesome little project that generates docs and an interface for API consumers to experiment with. 1 - https://developers.helloreverb.com/swagger/ 2 - http://swagger.wordnik.com/

The mock server generated out of a minimal markdown-like syntax seems pretty cool. As far as the docs themselves I think I prefer the design of something like Swagger (https://developers.helloreverb.com/swagger/).

I prefer hand-written. But other people like Swagger https://developers.helloreverb.com/swagger/, I/O Docs https://github.com/mashery/iodocs, Daux (although this is just a style framework) http://daux.io/ and http://apiary.io/

Very nice documentation! Mind sharing how you are generating your API documentation? Edit: Looks like it is Swagger. https://developers.helloreverb.com/swagger/

I'd like to see this combined with swagger: https://developers.helloreverb.com/swagger/

Wordnik's swagger comes to mind https://developers.helloreverb.com/swagger/ We just launched our own api ( handwritten with bootstrap,css ) check it out at http://appetite.io/docs ~B

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

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/

swagger (http://developers.helloreverb.com/swagger/) has been doing whats proposed here. By describing your APIs with swagger-spec you get a beautifully documented APIs, code generation of client libraries and some more stuff: https://github.com/wordnik/swagger-core/wiki/Downloads

This is essentially trying to solve the same problem as Swagger. Swagger is "a specification and complete framework implementation for describing, producing, consuming, and visualizing RESTful web services" [1]. Check out the spec on GitHub here [2]. [1]: http://developers.helloreverb.com/swagger/ [2]: https://github.com/wordnik/swagger-core/wiki

A friend of mine has been doing similar things with the Swagger documentation spec (https://developers.helloreverb.com/swagger/) While browsing the docs in a web browser you can fill out some fields for input and see what the output for that input is. My friend forked it and extracts and lists any example data so you can click to load that example into those fields (my idea!). I tried it out and it's a very nice way to learn/explore a new API, especially testing edge cases where the docs are ambiguous. It really hits a sweet spot when you have documentation browsing, live execution and example data. I think creating a similar interface combining docstrings, the repl and example data from test fixtures would be a nice tool to have (I find doctests to be one of those things that are better in theory than in practice as they get too long and maintenance is annoying, although perhaps a more literate style in your source code would change that).