python - 哪些工具可用于为 Flask 编写的 REST API 自动生成文档？

Question

已结束。此问题不符合 Stack Overflow guidelines .它目前不接受答案。

---

我们不允许提出有关书籍、工具、软件库等方面的建议的问题。您可以编辑问题，以便用事实和引用来回答它。

关闭 4 年前。

Improve this question

我正在寻找一种从我编写的 Flask REST API 自动生成 REST API 文档的快速方法。有谁知道可以做到这一点的工具以及我将如何标记代码？

Answer 1

我会推荐你​​Sphinx ，您将文档添加为 __doc__，Sphinx 的 autodoc 模块将为您生成文档(docs.python.org 也使用 Sphinx)。标记是 reStructuredText ，类似于 Markdown(如果你更喜欢 Markdown，可以使用 pdoc)。

例如:

@app.route('/download/<int:id>')
def download_id(id):
    '''This downloads a certain image specified by *id*'''
    return ...