エンドポイントツールウィンドウ
エンドポイント ツールウィンドウは、HTTP および WebSocket プロトコルのプロジェクトで使用されるクライアント API とサーバー API の両方の集約ビューを提供します。 ツールウィンドウは、マイクロサービスやバックエンドとフロントエンドの通信を開発する際に役立ちます。 また、サードパーティの API を調べるのにも役立ちます。

エンドポイント ツールウィンドウからエンドポイント宣言に移動するには、次のいずれかを実行します。
エンドポイントのコンテキストメニューから ソースに移動 を選択します。
エンドポイントを選択し、 F4 を押します。
エンドポイントをダブルクリックします。
エンドポイント ツールウィンドウでは、モジュール、タイプ、フレームワークごとにエンドポイントのリストをフィルターできます。 外部ソース (たとえば、 リモート OpenAPI 仕様) からエンドポイントをリストするには、 モジュール の 外部 を選択します。
非推奨としてマークされたエンドポイントには取り消し線 (取り消し線) が表示されます。
サポートされているフレームワーク
IntelliJ IDEA は、次のフレームワークからエンドポイントを認識します。
Jakarta EE WebSocket
Java EE WebSocket
JAX-WS
JAX-RS
JAX-RS クライアント
gRPC/ プロトブフ
MicroProfileRest クライアント
Spring Feign クライアント
Spring MVC
Spring リアクティブ WebSocket
Spring RestTemplate
Spring WS
Spring WebClient
Spring Web サービス
MicronautHTTP コントローラー
Micronaut HTTP クライアント
Micronaut 管理エンドポイント
Micronaut WebSocket
Ktor
Helidon MP
Helidon SE
Quarkus
OpenAPI 3
Swagger 2
WSDL
Retrofit 2
OkHttp 3+
ツールバー
項目 | 説明 |
|---|---|
モジュール | モジュールごとにエンドポイントをフィルタリングするか、外部モジュールを選択します |
タイプ | エンドポイントをタイプ別にフィルタリングする |
フレームワーク | フレームワークでエンドポイントをフィルタリングする |
OpenAPI ソースの構成: 外部 OpenAPI 仕様 (SwaggerHub など) を追加して、この仕様のエンドポイントを エンドポイント ツールウィンドウに含め、黄色の背景でハイライトします。 開いた OpenAPI 仕様 ウィンドウで、 リモート仕様 リストの 詳細については、 リモート OpenAPI 仕様を追加する を参照してください。 | |
詳細パネルの表示と非表示 | |
ツールウィンドウのレイアウトとフィルターを構成します。
|
エンドポイントの詳細
エンドポイントを選択すると、専用ペインに詳細が表示されます。 詳細ペインの表示と非表示を切り替えるには、 または
を使用します。
選択したエンドポイントに対して生成された HTTP または gRPC リクエストを表示します。
対応するサーバーが稼働中の場合、 リクエストの送信 をクリックしてレスポンスをすぐに確認するか、 エディターで開く をクリックしてエディターで別の HTTP リクエストファイルで編集することができます。 詳細については、 HTTP クライアント を参照してください。

選択したエンドポイントに対して生成された OpenAPI 仕様を表示します。
モジュール全体の OpenAPI 仕様を生成することもできます: エンドポイント ツールウィンドウでモジュールを右クリックし、 OpenAPI 仕様の下書きをエクスポート を選択します。

別のファイルで 仕様をプレビューするには、 をクリックします。
選択したエンドポイントのドキュメントを表示します。 エンドポイントをダブルクリックして、そのソースコードに移動します。

選択したエンドポイントにアクセスするためのクライアントコードの例を提供します。 フレームワーク リストを使用して、コードを表示するフレームワークまたは言語を選択します。
Retrofit および Ktor の場合は、 をクリックして ボイラープレートコードの表示 を選択し、インポートステートメントや HTTP クライアントインスタンスなどの必要なすべてのコード要素を含むリクエストサンプルを完成させることもできます。

コードサンプルをファイルに保存するには、コードの上にマウスを移動して をクリックします。 これにより、コードが新しいスクラッチファイルに保存されます。
サービスダイアグラム
IntelliJ IDEA は、マイクロサービス間の相互作用を示すダイアグラムを提供します。 エンドポイント ツールウィンドウで、 をクリックします。
