使用Swagger生成的新代码更新Flask代码

时间:2016-03-21 14:09:52

标签: python flask swagger

我最近开始使用Swagger生成瓶模板:http://editor.swagger.io/#/

我的工作流程有缺陷,我想知道我哪里出错了。 I:

  1. 使用UI编写API V1 .yaml
  2. 使用UI编辑器生​​成代码,该编辑器下载存根拉出
  3. 编写被删除的函数
  4. 这部分过程很好。但是,我们要说我们要添加新端点或更改现有端点。怎么办? I:

    1. 重新加载swagger编辑器
    2. 编辑yaml
    3. 生成代码,下载新的zip并吹走旧代码
    4. 获取新生成的代码并执行"自我合并"我将新的存根复制到旧代码中,并将新的yaml复制到旧的
    5. 烧瓶模板的初始生成与持续维护之间似乎存在差距。我做错了什么?

1 个答案:

答案 0 :(得分:5)

是的,AFAICS还没有真正好的工作流程。

您可以做的一件事是将原始生成的代码检查到名为“generated”或类似名称的分支上的git。然后将其合并到master并开始处理它。如果稍后您扩展了swagger定义,则可以再次生成代码,切换到生成的分支,使用新生成的代码覆盖现有代码,再次提交并合并到master。如果你只有一些额外的端点,这甚至可以在没有任何合并冲突的情况下工作。

如果swagger工具具有生成代码的概念并能够更新生成的代码,那当然会更好。但在此之前,这应该是一个可以忍受的解决方法。