Swagger 和 json-rpc

Posted 2023-02-16

【中文标题】Swagger 和 json-rpc

【英文标题】：Swagger and json-rpc

【发布时间】：2013-10-27 13:52:01

【问题描述】：

我正在尝试将 Swagger-ui 用于由 php 编写的 json-rpc 服务器。我使用Swagger-PHP 为 Swagger-ui 生成 json 投诉容器。所以，我对 Swagger 很陌生，我对这样的方法使用注释：

/**
 *  @SWG\Resource(
 *      apiVersion="0.2",
 *      swaggerVersion="0.8",
 *      basePath="http://mydomain.com",
 *      @SWG\Api(
 *          path="/rpc/json/server.php",
 *          description="Operations about Devices",
 *          @SWG\Operations(
 *              @SWG\Operation(
 *                  method="POST",
 *                  summary="Get device by ID",
 *                  nickname="getDevice",
 *                  @SWG\Parameters(
 *                      @SWG\Parameter(
 *                          name="deviceID",
 *                          description="device id",
 *                          required="true",
 *                          type="string"
 *                      )
 *                  ),
 *                  @SWG\ResponseMessages(
 *                      @SWG\ResponseMessage(code=404, message="Device not found")
 *                  )
 *              )
 *          )
 *      )
 *  )
*/

在 SWG\Operation 中，我需要添加一个与 json-rpc spec 对应的“方法”。 因此，所有请求都将使用 POST 方法作为 http 的一部分，而 json 容器将为每个请求都有自己的“方法”。

问题 - 我应该从哪里着手解决这个问题？

对不起我的英语。不是本地人。

【参考方案1】：

在@SWG\Api() 或@SWG\Operations() 中添加额外的@SWG\Operation()

我添加了an example，它在一个@SWG\Api() 中演示了多个操作。

这能回答你的问题吗？我不熟悉 json-rpc 规范。

【讨论】：

很遗憾没有。它强烈依赖于 JSON-RPC。如果我只添加一个操作，它将定义添加 json 请求，但不会更改 JSON 容器。