繁体   English   中英

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

[英]Python-Flask,Swagger, Generate API documents from annotations

我有一个现有的书面应用程序,其中API以下列方式编写:

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

我想从这种类型的API生成Swagger文档。 到目前为止,我尝试了很少的选项,但是大多数选项都是从yml文件或特定方法的docstring中的yml字符串生成文档。

我想使用基于注释的方法 有很少的库可以做到这一点但他们需要为我们在代码中没有的每个方法都有类(并且不可能更改所有代码)

任何人都可以给我一些指示吗? 你在项目中使用了什么?

你试过烧瓶傻瓜吗? 这不是你要求的,但最接近我迄今为止见过的真实事物。

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

更新:闪光灯 您将swagger doc放在装饰瓶的文档字符串中 - 方法和flasgger将为您的应用程序提供生成的输出的新端点。 效果很好!

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM