enunciate - Java Restful Web サービスでのドキュメント生成の問題を明らかにする

Question

Java RESTful Web サービス プロジェクトの enunciate プラグインを使用して REST ドキュメントを生成しようとしています。Mavenビルドを使用してPOM.xmlを実行するたびに。以下の警告が表示され、ドキュメントがまったく生成されません..

[警告] [ドキュメント] スプラッシュ パッケージ com.layer.rest.service.interfaces が見つかりません。スプラッシュのドキュメントは含まれていません。

手がかりを教えてください。

Answer 1

Enunciate は、次のように、enunciate.xml で定義したパッケージ内の package-info.java の JavaDoc を使用しようとします。

<enunciate label="Foo" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<modules>
    <docs title="My Foo API"
        splashPackage="org.foo"  />

この構成に基づいて、enunciate は を探しますorg.foo.package-info.java。見つからない場合は、受け取った警告が表示されます。

詳細については、httpsdocs ://github.com/stoicflame/enunciate/wiki/Module-Docs のモジュール ドキュメントを参照してください。