Python-Flask，Swagger，从注释生成API文档

Question

我有一个已经编写好的应用程序，其中API以以下方式编写：

@app.route('/')
def hello():
    return "Hello World":

我希望能够从这种类型的API生成Swagger文档。到目前为止，我尝试了几个选项，但大多数选项都是从yml文件或特定方法的docstring中的yml字符串生成文档。

我想使用基于注释的方法。有一些库可以做到这一点，但它们需要每个方法一个类，而我们的代码中没有这样的类（并且改变所有代码不可能）。

有人能给我一些指针吗？你在你的项目中使用什么？

- Ganesh Satpute

Answer 1

您尝试过flask-sillywalk吗？虽然不完全是您要求的，但这是我目前看到的最接近真实情况的东西。

当然，我也更喜欢能够使用docstring的内容来生成swagger输入的东西。

更新：有flasgger。您可以将swagger文档放在装饰的flask方法的docstrings中，flasgger将为您的应用程序提供一个新的端点，并生成输出。非常有效！

- Bastian Venthur