首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >Python,Swagger,从注释生成API文档

Python,Swagger,从注释生成API文档
EN

Stack Overflow用户
提问于 2017-05-04 06:54:37
回答 1查看 2.1K关注 0票数 4

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

代码语言:javascript
复制
@app.route('/')
def hello():
    return "Hello World":

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

我想使用基于注释的方法。这样做的库很少,但是它们需要为我们在代码中没有的每个方法设置类(并且不可能更改所有的代码)。

有人能给我指点吗?你在你的项目中使用什么?

EN

回答 1

Stack Overflow用户

发布于 2018-05-02 11:57:22

你试过水瓶-硅树脂了吗?这并不是你想要的,但这是我迄今所见过的最接近真实的东西。

当然,我也希望使用docstring的内容来生成swagger的输入。

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

票数 2
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/43775883

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档