0

0

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

霞舞

霞舞

发布时间:2024-09-26 08:03:16

|

989人浏览过

|

来源于dev.to

转载

具有多个 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 文件)

贝特协同办公系统(BetterCOS)
贝特协同办公系统(BetterCOS)

具备更多的新特性: A.具有集成度更高的平台特点,集中体现了信息、文档在办公活动中交流的开放性与即时性的重要。 B.提供给管理员的管理工具,使系统更易于管理和维护。 C.产品本身精干的体系结构再加之结合了插件的设计思想,使得产品为用户度身定制新模块变得非常快捷。 D.支持对后续版本的平滑升级。 E.最价的流程管理功能。 F.最佳的网络安全性及个性化

下载

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

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

这就是大家

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

感谢您的阅读,我希望这篇文章对您有用,就像对我一样;)

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

174

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

225

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

335

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

206

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

388

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

193

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

189

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

191

2025.06.17

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

74

2025.12.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Git 教程
Git 教程

共21课时 | 2.3万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.5万人学习

Git中文开发手册
Git中文开发手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号