How do you document your rest apis?

Question

Documentation

For example, I wrote my rest api, I want to let everyone use it, if there are any standard ways to create documentation or guides, cookbooks for creating documentation.

Answer 1

For example en.wikipedia.org/wiki/Web_Application_Description_Language . And for myself (two developers, a client and a server), google docs helps out so as not to bother.

Answer 2

apiary.io

Answer 3

I think that REST APi should be very simple and understandable, but I have not yet driven really complex representations.
As a dock, I usually give a minimal example of interaction in which I comment on the necessary actions and provide proper responses from the service. In principle, you can probably find a tool that will bring the example code to beautiful html, but this is more a matter of generating a dock in general and not for api.

Answer 4

All REST methods for me are described through annotations (Symfony 2) and then documentation is generated for them. Adding curl examples there is no problem.

Answer 5

I was wondering if you can find something useful for yourself.