Question

Martin，我一直在尝试使用你的wadl文档生成代码来记录来自Javadoc注释的REST接口，我一直无法让它记录方法/查询参数的参数。我不太确定我做错了什么。我以通常的方式向方法提供Javadoc注释，例如：

    /**
 * Gets an Account object by id.
 * @param req the HttpServletRequest encapsulating this GET request
 * @param q the id of the Account object to be returned
 * @param xid optional transaction id associated with this request
 * @return an AccountModel object corresponding to the requested it. 
 * If not found an APIException is thrown.
 */
@GET @Path("/id")
@Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
public AccountModel getAsXML_JSON(@Context final HttpServletRequest req, 
        @QueryParam("q") String q,
        @QueryParam("xid") String xid)

我确信我有一些明显缺失的东西。如上所述，注释“通过id获取Account对象”使其成为resourcedoc.xml文件，并从那里到application.wadl文件，但没有一个参数定义有效。当我添加

 * @annotationDoc {@name q} {@doc the id of the Account object to be returned}
 * @annotationDoc {@name xid} {@doc optional transaction id associated with this request}

我可以在resourcedoc.xml文件中看到参数的描述，但看起来它们出现在错误的位置，并且application.wadl文件中没有显示任何内容。我们非常感谢您提供的任何帮助。

Answer 1

回答我自己的问题，问题是resourcedoclet无法找到QueryParam或Context类的定义。因此，它将QueryParam插入到生成的XML中，但不包括标识QueryParam引用的参数的名称/值对。这导致生成的html包括方法描述，但不包括参数描述，因为无法找到QueryParam引用的参数。修复只是在调用resourcdoclet的Javadoc命令的类路径中包含jsr311-api-1.1.1.jar。

Answer 2

添加

<dependency>
    <groupId>javax.ws.rs</groupId>
    <artifactId>javax.ws.rs-api</artifactId>
    <version>2.0</version>
</dependency>

到你的pom.xml

如何在WADL生成的文档中获取参数说明

2 个答案: