具有多个 YAML 文件的开放 API 规范

每个记录过 REST API 的人都知道编写包含所有这些资源、路径、请求和架构的整个 YAML 文件是什么感觉，但突然间您发现自己保留了一个文件中最后一行的长度为 5 位。是的，很痛苦。

由于最好的应用程序是我们自己构建的应用程序，我发现自己在这个完全相同的地方记录工作中的 API，并且我进行了很多搜索，但没有找到解决此问题的单一可行的解​​决方案，这就是我们程序员的本能发挥作用的时候我们花费了五倍于我们应该为自己构建新工具的时间。这正是我所做的，我想与大家分享一个用 Go 编写的全新工具，用于将 YAML 文件合并到单个 boss 文件上，以用作 OpenAPI 规范。

介绍：GOpenAPI

GOpenAPI (Golang OpenAPI) 是一种工具，它使用名为 dirs.json 的文件在执行结束时将文件和目录（是的，相当于 yaml 的整个目录）扫描到单个 swagger.yaml 文件中。

您可以在这里查看源代码。请注意，存储库也是一个模板，可以克隆并用作草稿，以使用此工具创建您的第一个 OpenAPI 规范（如果您不愿意通过 go install 安装它，请确保保留 gopenapi 文件夹，否则它完全是可拆卸）

它是如何工作的（以及我能让它工作吗）

很简单，一旦您运行 gopenapi，它就会读取 dirs.json 文件并开始构建 OpenAPI 规范，其中包含其中声明的所有文件和文件夹。请注意，dirs.json 将使用文件作为唯一密钥，例如信息、服务器和安全性以及称为模板的密钥（这只是一个空白的 OpenAPI yaml 文件）

难以保存在单个文件中的资源和密钥（例如路径、模式和请求）可以存储在文件夹中，并且也可以使用 OpenAPI 上常见的 #ref 标签来提及这些资源和密钥，因为它们都是合并后转到同一个文件。

这个项目还附带了一个可以静态提供的index.html，它还与 dist 文件夹中包含的 Swagger UI 官方包进行交互。

这就是大家

我希望这个工具能够为那些（就像我一样）搜索了大量 reddits 和 github 存储库但没有找到他们正在寻找的工具的人提供。好吧，现在您已经拥有了它，并且它完全开源，这意味着，如果您看到任何可以解决的改进或问题，我会在与您合作解决它之前毫不犹豫地与您合作。另外，我对 golang 还很幼稚，所以这个项目可能还有很多需要改进的地方，我会尽力保持最新并不断改进它（因为我现在也会经常使用它）

感谢您的阅读，我希望这篇文章对您有用，就像对我一样；）

以上是具有多个 YAML 文件的开放 API 规范的详细内容。更多信息请关注PHP中文网其他相关文章！