【问题标题】:Documenting message based API in Swagger or RAML在 Swagger 或 RAML 中记录基于消息的 API
【发布时间】:2017-09-17 00:10:03
【问题描述】:

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

谢谢。 路易斯·奥斯卡

【问题讨论】:

  • OpenAPI/Swagger 不支持 RPC 样式的 API。对应的提案是#664#801

标签: swagger raml


【解决方案1】:

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

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

【讨论】:

  • 谢谢,很高兴知道,:-)
  • 谢谢@Jehof 我真的很重视你的回复。
猜你喜欢
  • 2016-03-26
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2015-03-27
  • 2011-03-28
  • 1970-01-01
  • 2023-03-04
相关资源
最近更新 更多