Playframework RPC风格的API、swagger和Play框架2(swagger核心)

Playframework RPC风格的API、swagger和Play框架2(swagger核心),playframework,rpc,playframework-2.1,swagger,Playframework,Rpc,Playframework 2.1,Swagger,我正在实现一个RPC类型的API应用程序。我正在使用Java on play框架。 我已经使用swagger模块为简单的restapi生成了swagger文档,其中每个“URL”映射到控制器中不同的静态函数。但在这里,我需要将一个URL和一个静态函数映射到API文档中的多个操作 基本结构相当经典 abstract class RPCActionRequest implements Serializable{ public int actionCode; //this might be an

我正在实现一个RPC类型的API应用程序。我正在使用Java on play框架。 我已经使用swagger模块为简单的restapi生成了swagger文档,其中每个“URL”映射到控制器中不同的静态函数。但在这里,我需要将一个URL和一个静态函数映射到API文档中的多个操作

基本结构相当经典

abstract class RPCActionRequest implements Serializable{
  public int actionCode; //this might be an enum too
  public RPCActionParam param;
}

interface RPCActionParam implements Serializable{
}

abstract class RPCAction {
  public int actionCode;
  public abstract RPCActionResult execute(RPCActionParam param);
}

interface RPCActionResult implements Serializable{
  public int responseCode; //sUCCESS, ERROR, FAIL, ... whatever errors my system needs to
                           //communicate to the client.
}
每个动作都映射到我的RPCController映射器中的相同静态函数,就像在play framework的routes文件中一样

/rpc/routes.RPCController.rpc()

如何使用swagger和swagger核心文档生成来记录所有操作、参数类和结果类?是否可以只使用swagger-play2模块的@Api*注释

参考文献:

-昂首阔步:

-大摇大摆的核心: