在 Swagger 或 RAML 中记录基于消息的 API

Lui*_*ros 4 swagger raml

我们如何在 Swagger 或 RAML 中记录基于消息的 API?我所说的基于消息的意思是端点总是相同的,但是可以向这个端点发送多种消息类型,并且根据输入消息的类型,我们会得到不同的响应。有没有我可以看看的这种类型的 API 的例子?

谢谢你。路易斯·奥斯卡

Jeh*_*hof 5

Swagger 和 OAS 尤其用于记录类 REST 的 API。经过长时间的搜索,我找到了AsyncAPI规范。这可用于记录您的消息驱动 API。

还有一个在线编辑器可用,如果您已经熟悉使用 swagger 和 yaml,则很容易开始使用此规范