0

enunciate を使用して REST API を文書化しています。ドキュメントを適切に生成することができ、かなり長い間使用しています。

私の問題は..複数のエンドポイントメソッドを持ついくつかのサービスクラスがあります。

public interface UserLoginService {
//This method should be DOcumented
@Path("/login")
@POST
@Consumes({"application/xml", "application/json"})
@Produces({"application/xml", "application/json"})
@Transactional(
 readOnly=false, 
rollbackForClassName="MyExceptionClass", 
propagation=Propagation.REQUIRED
)
@Deprecated
public UserDetails performLogin(LoginObj loginobj);


//This method should be skipped

@Path("/logout")
@GET
@Consumes({"application/xml", "application/json"})
@Produces({"application/xml", "application/json"})
@Transactional(
readOnly=false, 
rollbackForClassName="MyException", 
propagation=Propagation.REQUIRED
)
public UserDetails logout(@QueryParam("userid") String userid);
}

これらのサービス メソッドには、公開されているものと内部で使用されているものがあります。パブリックであるはずの Rest メソッドのみのドキュメントを生成したかったのです。クラスを除外するために除外APIクラスを使用していますが、いくつかのメソッドをスキップする方法をとにかく見つけることができませんでした。これを達成する方法はありますか。ドキュメントの bcoz だけの個別のクラスを作成したくありません。enunciate dosent の場合は、既存の enunciate javadoc から簡単に適用できる他のドキュメント ツールを使用してこれを行います。

4

2 に答える 2

1

参考までに、バージョン 1.27 には、API のファセットを除外する際により柔軟なEnunciate Facetsの概念が含まれます。

于 2013-07-06T20:14:14.417 に答える
0

古いバージョンの enunciate を使用していました。最新バージョンには注釈 @ExcludeFromDocumentation があります。この注釈を見ましたが、これはJaxb objのみに適用されるとdocに書かれていました。彼らのジラで、私の問題に対して提起され修正された欠陥を見ました。この注釈は、クラス/メソッドに使用できるようになりました。REST メソッドに対して使用した場合、メソッドは文書化されません。

于 2013-06-14T02:34:01.227 に答える