生成REST API文档的最佳方法是什么？

Question

我正在寻找一种生成REST API文档的好方法.它不需要实际连接代码或任何东西,但能够将文档编写为文本文件,将工具指向它并从中生成一些文档真是太棒了.

那里有人有什么想法吗？我知道我有点模糊,但说实话,我不太清楚我在这里寻找什么 - 主要是管理文档的简单方法.

Answer 1

据罗伊说:

"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."

自我描述性是REST的优势之一.