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

Documenting message based API in Swagger or RAML

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

谢谢。 路易斯·奥斯卡

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

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