エンドポイントツールウィンドウ
エンドポイントツールウィンドウは、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 は、マイクロサービス間の相互作用を示すダイアグラムを提供します。エンドポイントツールウィンドウで、 をクリックします。

使い方
関連ページ:
OpenAPI
OpenAPI 仕様 (OAS) は、REST API の記述形式です。Swagger は、REST API を作成、文書化、使用するための、この仕様に基づくツールのセットです。詳細については、「Swagger のドキュメント」を参照してください。IntelliJ IDEA は、YAML および JSON ファイル内の OpenAPI 定義のコーディング支援を提供し、サーバースタブ、クライアントライブラリ(SDK)、OpenAPI 仕様に基づくドキュメントを生成するための Swagger Codeg...
コード補完
基本コード補完は、可視性スコープ内のクラス、メソッド、フィールド、キーワードの名前を補完するのに役立ちます。IntelliJ IDEA はコンテキストを分析し、現在のキャレット位置から到達可能な選択肢を提案します。候補にはライブテンプレートも含まれます。補完機能は英語以外のキーボードレイアウトでも利用できます。基本補完を呼び出すデフォルトでは、IntelliJ IDEA は入力時に自動的にコード補完ポップアップを表示します。あるいは、を押すか、メインメニューからを選択することもできます。2 回...
HTTP クライアント
HTTP クライアントプラグインを使用すると、IntelliJ IDEA コードエディターで HTTP リクエストを直接作成、編集、実行できます。HTTP リクエストを作成して実行する必要がある場合、主に 2 つのユースケースがあります。RESTful Web サービスを開発していて、それが期待どおりに機能し、仕様に準拠してアクセス可能であり、正しく応答することを確認したい場合。RESTful Web サービスに対応するアプリケーションを開発している場合。この場合、開発を開始する前にサービスへの...
WireMock
IntelliJ IDEA は、HTTP サービスをスタブするためのツールである WireMock のサポートを提供します。スタブには、実際のサーバー通信を必要とせずに実際の API 動作を模倣するスタブの作成または API 呼び出しへの応答の設定が含まれます。WireMock プラグインをインストールするこの機能は、インストールして有効にする必要がある WireMock プラグインに依存しています。を押して設定を開き、を選択します。マーケットプレースタブを開き、WireMock プラグインを見つけて、イ...
Ktor
Ktor は、接続されたシステムを作成するための Web アプリケーションフレームワークです。これを使用して、サーバー側およびクライアント側のアプリケーションを作成できます。JVM、JavaScript、Kotlin/Native などの複数のプラットフォームをサポートします。IntelliJ IDEA は、Ktor プロジェクトを操作するために次の機能を提供します。新しいプロジェクトを作成するためのウィザード。Ktor プロジェクトを実行およびデバッグするための専用の実行構成。プロジェクト全体の...
重複ツールウィンドウ
重複ツールウィンドウには、重複の検索結果が表示されます。重複ツールウィンドウのペイン:このウィンドウは、次のペインで構成されています。左側のペインには、ソースコードの重複フラグメントのツリービューが表示されます。各ノードには次の情報が表示されます。スコープ内で検出された複製されたコードフラグメントの数。重複の「コスト」(コードブロックサイズの基底に加法アルゴリズムを使用して計算された任意の単位です ; 通常、コードフラグメントが大きいほどコストが高くなります)。重複しているクラスを含むクラス。...