设置多个swagger API文件

时间:2019-10-25 11:16:42

标签: swagger openapi

我正在研究一个项目,在其中我们重写现有应用程序的接口,并将所有内容移植到swagger / openAPI。

现在,每个功能都具有自己的yml文件,这是一个独立的规范。但是有一些缺点:

  • yml文件中的内容重复(例如可以跨文件共享的模型)
  • 重复的程序代码(由这些yml文件生成)。
  • 使用工具时必须分别处理每个yml文件。

理想情况下,我们希望为每个服务提供一个单独的文件夹,该特定服务的模型和服务描述应紧密结合在一起,但应与其他服务分开。当然,还有共享模型,然后我们需要将其放在其他文件夹中(例如“ / shared-models”)。最后,我们希望所有这些文件都包含在 1个主要yml根文件中。

因此,我们一直在研究使用$ref属性分割/导入文件。但是,要想出完整的文件和文件夹结构是很难的,因为该规范似乎允许在某些地方(但不是在所有地方)使用$ref。您不能随心所欲地拆分和构建文件。因此,我们可能需要进行某种权衡。

我特别想知道其他公司如何进行此设置。 (例如,使用企业级结构的swagger文件的设置的示例,将是很好的选择。)我们希望使事情保持简单,并尽可能根据标准或流行的惯例 >。

(为清楚起见:我的问题不是:“如何使用$ ref”)

0 个答案:

没有答案