什么是生成一个REST API文档的最佳方式？ [英] What's the best way to generate a REST API's documentation?

问题描述

我在找一个很好的方法来生成一个REST API文档。它并不需要真正的code或任何连接，但它会是真棒，能够写文件为文本文件，在安装时的工具，并且从它的一些文档。

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.

推荐答案

根据罗伊：

"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的好处之一。

Self-descriptiveness is one of the benefits of REST.

这篇关于什么是生成一个REST API文档的最佳方式？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！