0

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)

我敢肯定，我缺少一些明显的东西。如上所述，注释“Gets an Account object by id”使其进入 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 文件中没有显示任何内容。您可以提供的任何帮助将不胜感激。

4

2 回答 2

0

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

于 2012-11-02T16:11:07.260 回答
0

添加

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

到你的 pom.xml

于 2014-03-03T07:38:56.143 回答