將描述添加到RestEasy的Web服務參數？

Question

是否有某種方式/註釋可以將說明添加到RestEasy Web服務的參數中？我瀏覽了註釋的api-doc，但沒有發現任何內容。

這是爲了添加描述，以便它們反映在我將使用某種工具自動生成的REST API文檔中。

一個例子的Web服務接口：

@Path("list-all") 
@GET 
@RBAC(type = { CRUDEnum.READ }, capability = { "PowerUser" }) 
@ParseContext 
@Produces({ 
     "application/json", 
     "application/xml"}) 
public net.myapp.services getAllDevices(
     @QueryParam("start") int param0, @QueryParam("limit") int param1); 

Answer 1

找到該方式。沒有REST註釋來添加參數描述。

解決方法是使用典型的java-doc註釋。

例如

/** 
* @param param0 Paging parameter 
* @param param1 Paging parameter 
* */ 
@Path("list-all") 
@GET 
@RBAC(type = { CRUDEnum.READ }, capability = { "PowerUser" }) 
@ParseContext 
@Produces({ 
     "application/json", 
     "application/xml"}) 
public net.myapp.services getAllDevices(
     @QueryParam("start") int param0, @QueryParam("limit") int param1);