エンドポイントツールウィンドウ
エンドポイントツールウィンドウは、HTTP および WebSocket プロトコルのプロジェクトで使用されるクライアント API とサーバー API の両方の集約ビューを提供します。ツールウィンドウは、マイクロサービスやバックエンドとフロントエンドの通信を開発する際に役立ちます。また、サードパーティの API を調べるのにも役立ちます。
エンドポイントツールウィンドウからエンドポイント宣言に移動するには、次のいずれかを実行します。
エンドポイントのコンテキストメニューからソースに移動を選択します。
エンドポイントを選択し、F4 を押します。
エンドポイントをダブルクリックします。
エンドポイントツールウィンドウでは、モジュール、タイプ、フレームワークごとにエンドポイントのリストをフィルターできます。外部ソース (たとえば、リモート OpenAPI 仕様 ) からエンドポイントをリストするには、モジュールの外部を選択します。
非推奨としてマークされたエンドポイントには取り消し線 (取り消し線) が表示されます。
サポートされているフレームワーク
JetBrains Rider は、次のフレームワークからエンドポイントを認識します。
gRPC/ プロトブフ
MicroProfileRest クライアント
MicronautHTTP コントローラー
Micronaut HTTP クライアント
Micronaut 管理エンドポイント
Micronaut WebSocket
Helidon MP
Helidon SE
Quarkus
OpenAPI 3
Swagger 2
WSDL
Retrofit 2
OkHttp 3+
ツールバー
項目 | 説明 |
|---|---|
モジュール | モジュールごとにエンドポイントをフィルタリングするか、外部モジュールを選択します |
タイプ | エンドポイントをタイプ別にフィルタリングする |
フレームワーク | フレームワークでエンドポイントをフィルタリングする |
| OpenAPI ソースの構成 : 外部 OpenAPI 仕様 (SwaggerHub など) を追加して、この仕様のエンドポイントをエンドポイントツールウィンドウに含め、黄色の背景でハイライトします。開いた OpenAPI 仕様ウィンドウで、リモート仕様リストの 詳細は、リモート OpenAPI 仕様を追加するを参照してください。 |
| 詳細パネルの表示と非表示 |
| ツールウィンドウのレイアウトとフィルターを構成します。
|
をクリックし、OpenAPI 仕様ファイルの URL を指定するか、
エンドポイントの詳細
エンドポイントを選択すると、専用ペインに詳細が表示されます。詳細ペインの表示と非表示を切り替えるには、
または 
を使用します。
選択したエンドポイントに対して生成された HTTP または gRPC リクエストを表示します。
対応するサーバーが実行中の場合は、要求を送信して応答をすぐに確認することも、エディターで別の HTTP 要求ファイルで応答を開くこともできます。詳細については、HTTP クライアントを参照してください。
選択したエンドポイントに対して生成された OpenAPI 仕様を表示します。
モジュール全体の OpenAPI 仕様を生成することもできます。エンドポイントツールウィンドウでモジュールを右クリックし、OpenAPI 仕様の下書きをエクスポートを選択します。
別のファイルで仕様をプレビューするには、
をクリックします。
選択したエンドポイントのドキュメントを表示します。エンドポイントをダブルクリックして、そのソースコードに移動します。
関連ページ：
言語およびフレームワーク: OpenAPI
OpenAPI 仕様 (OAS) は、REST API の記述形式です。Swagger は、REST API を作成、文書化、使用するための、この仕様に基づくツールのセットです。詳細については、「Swagger のドキュメント」を参照してください。JetBrains Rider は、YAML および JSON ファイル内の OpenAPI 定義のコーディング支援を提供し、サーバースタブ、クライアントライブラリ（SDK）、OpenAPI 仕様に基づくドキュメントを生成するための Swagger Cod...
コード補完 (IntelliSense)
JetBrains Rider のコード補完機能に慣れ親しむために、実装の基礎をいくつか紹介します。新しい識別子の入力を開始するとすぐに、自動補完の候補リストが表示されます。を押すと、基本補完の候補リストが表示されます。他の 2 つの補完コマンド、型一致補完および第 2 基本補完は、高度なアルゴリズムを適用して、候補リストにさらに項目を追加します。AI Assistant を有効にしている場合は、周囲のコンテキストに基づいてコードブロック全体を作成できる AI を搭載したコード補完を利用できます。...
HTTP クライアント
HTTP クライアントプラグインを使用すると、JetBrains Rider コードエディターで HTTP リクエストを直接作成、編集、実行できます。HTTP リクエストを作成して実行する必要がある場合、主に 2 つのユースケースがあります。RESTful Web サービスを開発していて、それが期待どおりに機能し、仕様に準拠してアクセス可能であり、正しく応答することを確認したい場合。RESTful Web サービスに対応するアプリケーションを開発している場合。この場合、開発を開始する前にサービス...
ドキュメントツールウィンドウ
デフォルトでは、JetBrains Rider はポップアップにクイックドキュメントを表示します。ツールウィンドウで表示するには、ポップアップでクリックしてドキュメントツールウィンドウで開くを選択するか、を 2 回押します。または前のページに切り替えるか、次のドキュメントページに移動します（たとえば、ハイパーリンクをクリックした後）。macOS では、3 本の指で右から左、左から右にスワイプするジェスチャーも使用できます。ドキュメントが現在開いているシンボルのソースコードに移動します。ドキュ...