2011-01-31 14 views
1

クライアントがWebサービスにヒットでき、通常のindex.jspページを表示するのではなく、など)私は代わりに、Webサービスを介して利用可能なメソッドからjavadocsを表示することができます。これの主な目標はREST Webサービス用のindex.jspページの代わりにjavadocを公開する方法

<welcome-file-list> 
<welcome-file>index.jsp</welcome-file> 
</welcome-file-list> 

:私は、一般的にはREST/Webサービスに非常に新しいですが、私はMyEclipseのを使用していると私は現在、それはそうのようなweb.xmlファイルを介してindex.jspページにアクセスしていることを知っています私のWebサービスで利用可能なメソッドのそれぞれを表示するウェルカムページを作成するのに時間を費やす必要はなく、代わりに自動化して読みやすくするようにしてください。

さらに詳しい情報が必要な場合は、私はそれを追加して喜んでいただければ幸いです。ありがとう。

編集:

私はただのjavadocとしてエクスポートし、私は/パブリックメソッドのみを必要なファイルのみを選択することになりました。次に、Webルートの内部で作成されたドキュメントフォルダを配置し、

<welcome-file-list> 
<welcome-file>index.html</welcome-file> 
</welcome-file-list> 

にweb.xmlファイルを編集し、それがに比べて検索することを知っていたように、通常のindex.htmlでパスだけでなく、Link to<A HREF="doc/の前に<FRAME src="doc/を置いWebルートの代わりにdocフォルダ。

答えて

1

すべてのページにjavadocを生成した場合(そこには優れたツールがあり、ビルドシステムに組み込まれていても)、それらのページをWebアプリケーションに直接簡単にマップできます。したがって、index.jspを表示する代わりに、生成されたjavadocsからindex.htmlを表示します。

+0

を、HTTPにマッピングされたもの、すなわちリクエスト。これが標準のjavadocツールで可能かどうかは不明です。 – Qwerky

+0

作成したindex.htmlを表示する方法を説明しておけば、これは役に立ちましたが、一般的には役に立ちましたので、これを回答として受け付けています。私はあなたが応答を与えた後で明示的にそれを求めなかったので、それはどうにか私のせいです。 – Mike

0

Javadocについてはわかりませんが、あなたのサービスを記述するのにWADLファイルを考えたことがありますか?

あなたがジャージーを使用している場合は、この記事が役立つことがあります。それは、私は彼が唯一のサービスで利用可能なメソッドを公開したいと思い、公開APIなら

http://wikis.sun.com/display/Jersey/HowToConfigureExtendedWADL

+0

ありがとう、遅い応答を申し訳ありませんが、私はこれを調べ、必要な機能を提供しているかどうかを確認します – Mike

関連する問題