What is the best way to create REST API documentation?

I am looking for a good way to create documentation for the REST API. He does not really need to connect to the code or anything else, but it would be great to be able to write documentation in the form of text files, point to a tool and generate some documents from it.

Does anyone have any ideas? I know that I'm a little vague, but to be honest, I'm not quite sure what I'm looking for here is basically an easy way to manage the documentation.

+5
source share
3 answers

According to Roy :

"A REST API should spend almost all of its descriptive
 effort in defining the media type(s) used for representing
 resources and driving application state, or in defining
 extended relation names and/or hypertext-enabled mark-up
 for existing standard media types."

Self-description is one of the benefits of REST.

+5
source

REST, Sphinx API XML-RPC, API . Sphinx ReStructuredText, , : ReStructuredText, Sphinx HTML PDF , . ; , , .

0

RESTful API. RESTx, : , -, ( JSON, -). URI . , .

, - RESTful , HTML JSON.

0