在flasgger中包含外部yml文件

Question

我想使用json远程引用创建一个单独的definitions.yml文件，这样我就可以在多个YML文件之间共享定义。

我们按照https://azimi.me/2015/07/16/split-swagger-into-smaller-files.html中的说明将定义部分移到了一个单独的文件中。最小的YML文件如下所示：

api.yml：

responses:
  '200':
    description: "A user."
    schema:
      $ref: "#/definitions/User"
definitions:
  $ref: "./definitions.yml"

definitions.yml

User:
  type: string

somefile.py

from flasgger import swag_from
...
# use BluePrint to specify API
@swag_from('api.yml')

命令

flask run

预期的localhost:5000/apidocs结果将有一个完整的GET API，并将用户定义为一个模型。实际结果显示没有找到'#/definitions/User‘，并且缺少模型。

flasgger支持这一点吗？

Answer 1

当前版本的flassger (0.9.3)不支持包含外部yaml文件，但是，可以在flask脚本内或在运行flask脚本之前对文件进行预处理，以包含外部引用。这里有一个connexion解决方案的例子：https://github.com/zalando/connexion/issues/254#issuecomment-497194240

Answer 2

您可以导入文件

definitions:
  import: "./definitions.yml"