如何将 swagger openapi 输出 (JSON) 与创作工具 (archbee) 同步

问题描述 投票:0回答:1

开发团队定义了一组 openapi 端点。如果我在防火墙内并使用“尝试”功能,我可以在 SwaggerUI 中查看它们。

我希望能够在创作工具(archbee)中记录 API。我还希望能够在文档中添加 API 描述(例如,我想提供属性的完整描述)。 关于如何与 JSON 文件同步但同时不丢失我手动添加的内容的任何想法。

另一个问题是从防火墙外部获取内容的问题 - 我猜可能将 JSON 文件托管在 GitHub 之类的地方可能会有所帮助?

swagger
1个回答
0
投票

这里的关键是解析 openApi JSON 文件以获得所需的内容。之后您可以将其转换为 archbee 文档平台使用的格式(此处为 Markdown),但在单独的文件中,以便您可以手动添加内容。

为此,您可以使用您最喜欢的语言(例如Python)的脚本和解析模块。当然,如果 json 仅可通过内部网络使用,则脚本将只能在其上获取数据。

另一个因素是您希望如何自动化该过程,您可以在特定时间段内自动触发脚本,例如每天或每次修改 JSON 文件时。

© www.soinside.com 2019 - 2024. All rights reserved.