エンドポイントツールウィンドウ
開発中のアプリケーションで Express(英語)、Next.js(英語)、GraphQL(英語) を使用している場合、エンドポイントツールウィンドウでルートハンドラーの概要を確認できます。このツールウィンドウは、マイクロサービスやバックエンドとフロントエンド間の通信の開発に役立ちます。また、サードパーティ API の利用にも役立ちます。

エンドポイントツールウィンドウからエンドポイント宣言に移動するには、次のいずれかを実行します。
エンドポイントのコンテキストメニューからソースに移動を選択します。
エンドポイントを選択し、F4 を押します。
エンドポイントをダブルクリックします。

エンドポイントツールウィンドウで、エンドポイントのリストをモジュール、タイプ、フレームワークでフィルタリングできます。外部ソースからのエンドポイントをリストするには、モジュールの外部を選択します。

非推奨としてマークされたエンドポイントには取り消し線 (取り消し線) が表示されます。
始める前に
デフォルトでは、エンドポイントツールウィンドウは WebStorm では使用できません。
エンドポイントツールウィンドウを追加するには、設定 | プラグインページのマーケットプレースタブにエンドポイントプラグインをインストールします。
REST API を使用するには、OpenAPI 仕様プラグインをインストールします(設定 | プラグインページ、タブマーケットプレース)。
詳細は、マーケットプレイスからプラグインをインストールするを参照してください。
ツールバー

項目 | 説明 |
|---|---|
モジュール | モジュールごとにエンドポイントをフィルタリングするか、外部モジュールを選択します |
タイプ | エンドポイントをタイプ別にフィルタリングする |
フレームワーク | フレームワークでエンドポイントをフィルタリングする |
| OpenAPI ソースの構成 : 外部 OpenAPI 仕様 (SwaggerHub など) を追加して、この仕様のエンドポイントをエンドポイントツールウィンドウに含め、黄色の背景でハイライトします。開いた OpenAPI 仕様ウィンドウで、リモート仕様リストの ![]() WebStorm での RESTAPI の操作(英語)の詳細を参照してください。 |
| 詳細パネルの表示と非表示 |
| ツールウィンドウのレイアウトとフィルターを構成します。
|
エンドポイントの詳細
エンドポイントを選択すると、専用ペインに詳細が表示されます。詳細ペインの表示と非表示を切り替えるには、 または
を使用します。
選択したエンドポイントに対して生成された HTTP または gRPC リクエストを表示します。
対応するサーバーが稼働中の場合、リクエストの送信をクリックしてレスポンスをすぐに確認するか、エディターで開くをクリックしてエディターで別の HTTP リクエストファイルで編集することができます。詳細については、HTTP クライアントを参照してください。

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

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

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

コードサンプルをファイルに保存するには、コードの上にマウスを移動して をクリックします。これにより、コードが新しいスクラッチファイルに保存されます。
関連ページ:
プラグインのインストール
プラグインは WebStorm のコア機能を拡張します。例: プラグインをインストールして、次の機能を取得します。バージョン管理システム、課題追跡システム、ビルド管理サーバー、その他のツールとの統合。さまざまな言語とフレームワークのコーディング支援サポート。ショートカットのヒント、ライブプレビュー、ファイルウォッチャーなど。新しいプログラミング言語を学ぶのに役立つコーディング演習。デフォルトでは、WebStorm には多数のプラグインがバンドルされています。バンドルされたプラグインを無効にするこ...
コード補完
基本コード補完は、可視性スコープ内のクラス、メソッド、フィールド、キーワードの名前を補完するのに役立ちます。WebStorm はコンテキストを分析し、現在のキャレット位置から到達可能な選択肢を提案します。JSDoc コメント、TypeScript 型定義などからの追加情報も補完精度を大幅に向上させます。候補にはライブテンプレートも含まれます。補完機能は英語以外のキーボードレイアウトでも利用できます。補完はサードパーティのコードのシンボルに対しても機能します。ほとんどの場合、必要なのは、必要なファイ...
HTTP クライアント
HTTP クライアントプラグインを使用すると、WebStorm コードエディターで HTTP リクエストを直接作成、編集、実行できます。HTTP リクエストを作成して実行する必要がある場合、主に 2 つのユースケースがあります。RESTful Web サービスを開発していて、それが期待どおりに機能し、仕様に準拠してアクセス可能であり、正しく応答することを確認したい場合。RESTful Web サービスに対応するアプリケーションを開発している場合。この場合、開発を開始する前にサービスへのアクセスと...
OpenAPI
OpenAPI 仕様 (OAS) は、REST API の記述形式です。Swagger は、REST API を作成、文書化、使用するための、この仕様に基づくツールのセットです。詳細については、「Swagger のドキュメント」を参照してください。WebStorm は、YAML および JSON ファイル内の OpenAPI 定義のコーディング支援を提供し、サーバースタブ、クライアントライブラリ(SDK)、OpenAPI 仕様に基づくドキュメントを生成するための Swagger Codegen との統...
重複ツールウィンドウ
重複ツールウィンドウには、重複の検索結果が表示されます。重複ツールウィンドウのペイン:このウィンドウは、次のペインで構成されています。左側のペインには、ソースコードの重複フラグメントのツリービューが表示されます。各ノードには次の情報が表示されます。スコープ内で検出された複製されたコードフラグメントの数。重複の「コスト」(コードブロックサイズの基底に加法アルゴリズムを使用して計算された任意の単位です ; 通常、コードフラグメントが大きいほどコストが高くなります)。重複しているクラスを含むクラス。...
