如何集成不同API的openapi规范? [英] How to integrate openapi specifications from different APIs?
本文介绍了如何集成不同API的openapi规范?的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!
问题描述
我想问问有没有办法轻松聚合不同接口的OpenApi规范?
我们当前为每个API使用Swagger,在那里我们添加了用于身份验证的自定义逻辑,我们还为不同的辅助功能规则添加了规则。
但是,以某种方式聚合所有这些API并将身份验证和访问逻辑放在同一位置会方便得多。
示例:
我们有两个独立的微服务,具有独立的API和独立的地址
API 1本地主机:5000
- 使用Orders API分离项目
- 可通过此url访问的单独的swagger
API 2 url localhost:5001
- 使用通知接口分隔项目
- 可通过此url访问的单独的swagger
我们想要的最终结果:
某种聚合框架或示例项目,能够将由Swagger生成的Open API规范拉入这些项目,并基本上将其显示为
下的某个新url下的一个规范url localhost:5002
- 我们从Orders API和Notification API获得显示端点的聚合Swagger或其他框架
基本上,我认为这个问题在使用需要从多个微服务向客户端提供某种公共API规范的微服务的人中很常见。在大多数情况下,客户希望将其视为一个
推荐答案
如果我正确理解您的问题,建议的方案是:
- 合并您的doc.xml文件
- 然后将XML转换为YAML(示例如下https://codebeautify.org/xml-to-yaml)
- 然后将YAML转换为Swagger预览(示例如下https://editor.swagger.io)
这篇关于如何集成不同API的openapi规范?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!
查看全文