2013-10-27 5 views
1

Я пытаюсь использовать Swagger-ui для моего сервера json-rpc, который был написан php. Я использую Swagger-PHP для создания контейнера жалоб json для Swagger-ui. Таким образом, я очень новой для Swagger и я использую аннотацию методы, как, что:Swagger и json-rpc

/** 
* @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 \ Операции мне нужно добавить еще один «метод» в соответствии с JSON-RPC spec. В результате все запросы будут использовать метод POST как часть http, а json-контейнер будет иметь свой собственный «метод» для каждого из них.

Вопрос - где я должен начать поиск, чтобы решить эту проблему?

Извините за мой английский. Не родной.

ответ

0

Добавить дополнительный @SWG \ Операция() s внутри @SWG \ Api() или @SWG \ Операций()

Я добавил an example, который демонстрирует несколько операций в одном @SWG \ Api() ,

Отвечает ли это на ваш вопрос ?, я не знаком с спецификацией json-rpc.

+0

К сожалению, нет. Это сильно зависит от JSON-RPC. Если я добавлю еще одну операцию, он определит запрос добавления json, но не изменит контейнер JSON. –