問題タブ [enunciate]

Javaで書かれたMaven-JAX-RSプロジェクトがあり、enunciateを使用してビルドごとにドキュメントを自動的に生成しています。これまでのところ、うまく機能しています。彼は私のプロジェクトのすべての REST エンドポイントの API ドキュメントを生成しています。

これで、便利な jdoc を使用していくつかの util-classes も作成しましたが、これらのクラスはエンドポイントではないため、enunciate にはそれらが含まれません。

いくつかの追加クラスの jdoc を使用して追加のドキュメントを生成する必要があることを enunciate に伝える方法はありますか? enunciate.xml で手動で構成する方法があるはずだと思いましたが、有効な解決策が見つかりません...

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

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

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

Enunciate maven プラグインを使用するために遭遇した問題を解決するのを手伝ってくれませんか? 問題は、私のドメインが API プロジェクト (パッケージではなく Java プロジェクト) ではなく、他のプロジェクトにあるため、ドキュメントを生成するときにデータ モデルはありませんが、同じプロジェクトにデータ モデル (@XmlRootElement) を作成することです。 API、生成しました。では、プラグインは他のプロジェクトにあるデータ モデルを生成できますか?

Enunciate を使用して Maven プロジェクトで REST API ドキュメントを生成しています。

アーティファクトmaven-enunciate-pluginは Web API ドキュメントを生成しますが、次のような Spring アノテーションを無視します: @Secured(spring-security から)

spring をサポートする maven アーティファクトでドキュメントを生成しようとしmaven-enunciate-spring-pluginましたが、Web API ドキュメントも生成しません。

Enunciate によって生成されたドキュメントで Spring からの注釈が認識され、言及されるように、enunciate を構成するか、別の enunciate maven プラグインを使用する方法はありますか?

Web サービス レイヤーにEnunciate ( http://enunciate.codehaus.org/ ) を使用しています。非常に単純なことをしたいだけですが、ドキュメントが見つかりません。

いくつかの画像やその他の静的リソースをデプロイし、たとえばからアクセスできるようにしたいhttp://localhost:8080/myapp/images/img01.png

images下にフォルダーを作成しようとしましたsrc/main/resourcesが、希望どおりに展開されません (そこにあるすべてのファイル/フォルダーは myapp/WEB-INF/classes に移動しますが、これは予想どおりです)。

enunciate プロジェクトの静的リソースはどこにあるのでしょうか。

enunciate フレームワークによって自動的に生成されるため、web.xml はありません。

Enunciate を使用して、Resteasy サービスのドキュメントを生成しています。必要なドキュメントを生成することはできますが、いくつかのカスタム パラメータに関して問題があります。

サービス インターフェイスは@QueryParam、メソッド実装がサポートするすべてのクエリ パラメータをリストするために使用されるカスタム アノテーションで構成されます。カスタム を使用することにした理由については、今は説明したくありません@QueryParam。それは単なるアーキテクチャ上の決定でした。

Enunciate はカスタムを認識しない@QueryParamため、すべての Resteasy メソッドには@QueryParamパラメーターがありません ( のみ@PathParam)。

サンプル サービス インターフェイス:

@QueryParam クラスの実装:

@QueryParams クラスの実装:

@QueryParam HTML ドキュメントを生成する際に、私のカスタムも考慮するように Enunciate に指示する方法はありますか?

Enunciate を使用して、マルチモジュール Maven プロジェクト内の RestEasy サービスのドキュメントを生成しています。応答オブジェクト属性の説明を取得しようとすると、ドキュメントの生成に問題があります。

たとえば、私のサービスが次のように定義されているとします。

ドキュメントが生成されるとき、属性の説明は生成されません。

すべての応答オブジェクトで、私は取得します (ドキュメントは提供されません)。1 つの重要な考え方は、すべての応答クラスがサービスとは異なる Maven モジュールにあるということです。応答クラスは UTIL モジュールにあります。サービスは EJB モジュールにあります。

問題の原因は間違いなくマルチモジュール Maven プロジェクトにあります。クラスが EJB モジュールにもある応答オブジェクトを定義すると、ドキュメントは完璧になります (説明も生成されます)。

理由と解決策は次のとおりです: https://github.com/stoicflame/enunciate/wiki/Multi-Module-Projects-%28Version-1%29

それにもかかわらず、私の問題を解決するために正確に何をすべきか、さまざまな pom (EJB および UTIL) 内に何を設定するべきかはまだわかりません。

どんな助けでも大歓迎です。