【问题标题】:JSON-RPC Swagger combinationJSON-RPC Swagger 组合
【发布时间】:2015-06-29 16:03:05
【问题描述】:

我正在考虑使用 this library 为我的 Web 服务实现 JSON-RPC。我还想为我的服务实现Swagger。

但是,我不确定这两者是否是一个很好的组合。在 JSON-RPC 中,所有方法都在同一个资源后面,而在 Swagger 中这没有任何意义。

我想知道以下几点:

  1. 能否将这些技术充分结合起来?
  2. JSON-RPC 仍然是一种很好的技术吗?还是手动实现更好?

感谢您的想法。

相关的未回答问题:Swagger and json-rpc

【问题讨论】:

  • 你找到任何替代 json-rpc api 文档生成器的方法了吗?

标签: php json swagger json-rpc


【解决方案1】:

关于 API 模式的一句话...

JSON-RPC 非常强大。它与传输无关,因为 REST 被锁定到 HTTP。如果你想使用流而不是孤立的请求,你将不得不做很多事情。 JSON-RPC 从一开始就改变了你的范式,通过任何新的传输(socket.io、原始二进制文件、ZeroMQ、传真->OCR、sms、任何东西)运行你的 API 都是一个简单的实现。

在我看来,JSON-RPC 之于 REST,就像 REST 之于 SOAP

【讨论】:

【解决方案2】:

来自 Swagger 团队,对 JSON-RPC 知之甚少,我可以提供部分答案。

根据您在问题中的描述,绝对不可能使用 Swagger 来记录这样的 API。 Swagger 只能记录唯一操作被定义为路径和 HTTP 动词的组合的唯一操作。

不幸的是,我无法评论 JSON-RPC 的强大功能,不是因为偏见,而是因为我对它的机制不够了解。此外,Swagger 在描述类似 REST 的 API 时并不打算覆盖 100% 的用例,这并不意味着超出其范围的任何东西都是不好的。

【讨论】:

  • 感谢您的回答!我认为我只需要选择两者之一
  • 我希望看到 Swagger 采用/适应支持 JSON-RPC。正如下面的评论所说,JSON-RPC 真的很棒。如果能够利用 Swagger 的强大功能,那就太好了。
猜你喜欢
  • 1970-01-01
  • 2013-09-12
  • 2015-03-07
  • 1970-01-01
  • 1970-01-01
  • 2011-02-07
  • 2013-12-16
  • 2021-02-24
  • 1970-01-01
相关资源
最近更新 更多