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)

私が見逃している明らかな何かがあると確信しています。上記のように、「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 ファイルには何も表示されません。あなたが与えることができるどんな助けも大歓迎です。

4

2 に答える 2

0

私自身の質問に答えると、問題は resourcedoclet が QueryParam または Context クラスの定義を見つけられないことでした。そのため、生成された XML に QueryParam が挿入されましたが、QueryParam が参照するパラメーターを識別する名前と値のペアが含まれていませんでした。これにより、メソッドの説明を含む HTML が生成されましたが、QueryParam が参照するパラメーターが見つからなかったため、パラメーターの説明は含まれていませんでした。修正は、リソースドックレットを呼び出す Javadoc コマンドのクラスパスに jsr311-api-1.1.1.jar を含めることだけでした。

于 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 に答える