All geek questions in one place

API Document Creation Tool

I have a RESTful API written in RubyOnRails (restfulie gem). What is the best way to generate api documentation from project sources?

+3
source share
2 answers

rake doc:app will turn your formatted rdoc comments for your methods into properly formatted html

+3
source

idlefingers has this right, but here is the complete answer for beginners:

  • Include rdoc in your gemfile: gem "rdoc"
  • Run the $ rake doc file: documentation application
  • Access rdoc by opening the doc / app / index.html file in your browser
+1
source

Source: https://habr.com/ru/post/1781438/

More articles:


All Articles