Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What's the best way to generate a REST API's documentation? [closed]

I'm looking for a nice way to generate documentation for a REST API. It doesn't need to actually connect with the code or anything, but it'd be awesome to be able to write the documentation as text files, point the tool at it, and generate some docs from it.

Anyone out there have any ideas? I know I'm being a bit vague, but, to be honest, I'm not quite sure what I'm looking for here--mainly an easy way to manage documentation.

like image 381
Kyle Slattery Avatar asked Oct 14 '22 22:10

Kyle Slattery


1 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-descriptiveness is one of the benefits of REST.

like image 100
fumanchu Avatar answered Oct 20 '22 09:10

fumanchu