言語およびフレームワーク: OpenAPI

OpenAPI 仕様 (OAS) は、REST API の記述形式です。 Swagger(英語) は、REST API を作成、文書化、使用するための、この仕様に基づくツールのセットです。詳細については、「Swagger のドキュメント(英語) 」を参照してください。

JetBrains Rider は、YAML および JSON ファイル内の OpenAPI 定義のコーディング支援を提供し、 Swagger Codegen との統合により、OpenAPI 仕様に基づいてサーバースタブ、クライアントライブラリ（SDK）、ドキュメントを生成することができます。

エンドポイントツールウィンドウを使用して、OpenAPI 仕様で定義されているすべてのエンドポイントを表示できます。

さらに、OpenAPI 仕様から定義されたエンドポイントへ HTTP リクエストを作成し、組み込みの HTTP Client で実行できます。

OpenAPI 仕様を作成する

JetBrains Rider は、関連するコーディング支援を備えた専用の OpenAPI 仕様ファイルタイプを認識します。これらは、OpenAPI 仕様バージョンの定義を持つ通常の YAML または JSON ファイルです。

OpenAPI 仕様を手動で作成する

プロジェクトツールウィンドウで Alt+Insert を押し、コンテキストメニューから OpenAPI 仕様を選択します。
ファイルの名前を指定し、仕様バージョンとファイルフォーマットを選択します。

エディターで開いた OpenAPI 仕様では、ガターアイコンを使用して仕様セクションをすばやく追加します。

IDE 設定の言語& フレームワーク｜ OpenAPI 仕様で仕様のクイック編集用ガターアイコンチェックボックスを使用して、ガターアイコンを無効にすることができます。

新しい OpenAPI 仕様ファイルには、フォーマットとバージョンに応じて、次のテンプレートが含まれています：

                    openapi: 3.0.0
                    info:
                        title: Title
                        description: Title
                        version: 1.0.0
                    servers:
                        - url: 'https'
                    paths:

                
    

                    {
                        "openapi": "3.0.0",
                        "info": {
                            "title": "Title",
                            "description": "Title",
                            "version": "1.0.0"
                        },
                        "servers": [
                            {
                                "url": "https"
                            }
                        ],
                        "paths": {

                        }
                    }

                
    

                    swagger: "2.0"
                    info:
                        title: Title
                        description: Title
                        version: 1.0.0
                    host: www
                    schemes:
                        - https
                    paths:

                
    

                    {
                        "swagger": "2.0",
                        "info": {
                            "title": "Title",
                            "description": "Title",
                            "version": "1.0.0"
                        },
                        "host": "www",
                        "schemes": [
                            "https"
                        ],
                        "paths": {

                        }
                    }

                
    

空の YAML または JSON ファイルから始める場合、 opnp または swag を入力し、 Tab を押すと、対応するライブテンプレートを挿入できます。

URL マッピングに基づいて OpenAPI 仕様を生成する

ソースコードに URL マッピングがある REST コントローラーがある場合、コントローラーコードから OpenAPI 仕様をすばやく生成することができます。

コントローラーパスの横にあるをクリックします。
OpenAPI の下書きを生成するを選択します。

生成されたファイルはスクラッチとコンソール | OpenAPI 仕様に保存されます。

このアクションは、モジュール全体の OpenAPI 仕様を生成できるエンドポイントツールウィンドウでも使用できます。

別のファイルから定義を参照する

OpenAPI 3.0 では、 $ref(英語) キーワードを使用して、任意の場所でホストされている定義を参照できます。 JetBrains Rider は、パスの補完、検証、迅速なナビゲーションを提供します。補完において、JetBrains Rider は現在のファイルや外部ファイルのコンテキストを理解し、関連する要素へのポインターの使用を提案します。

$ref キーワードを入力します。
外部定義へのパスの入力を開始します。

Ctrl+B を押すと、参照するファイルと要素にすばやく移動できます。

OpenAPI 仕様をプレビューする

統合された Swagger UI または Redoc UI を使用して、OpenAPI 仕様をプレビューできます。 OpenAPI 仕様ファイルがエディターで開かれている場合、右上隅のおよびを使用してプレビューを表示または非表示にします。

Swagger UI と Redoc UI を切り替えるには、プレビュー領域にカーソルを置き、をクリックします。

エディターを分割して水平方向にプレビュー

デフォルトでは、エディターとプレビューは縦に分割（並列）され、ワイドモニターに便利です。横に分割することもでき、プレビューがエディターの下部に表示されるため、縦型ディスプレイに便利です。

エディターの右上隅にあるをクリックして、エディタープレビューペインを開きます。
をクリックして、エディターとプレビューを水平に分割します。

リモート OpenAPI 仕様を追加する

プロジェクトの OpenAPI 仕様で定義したエンドポイント URL は、コード補完で利用できます。外部仕様のクライアントコードを記述している場合は、エンドポイント URL を自動補完するためにプロジェクトにファイルとして追加する必要はありません。関連するリモート仕様へのリンクを追加できます。

設定ダイアログ（Ctrl+Alt+S ）で、言語& フレームワーク｜ OpenAPI 仕様を選択します。
リモート仕様リストでをクリックして、OpenAPI 仕様ファイルの URL を指定するか、 SwaggerHub(英語) で OpenAPI 仕様を見つけます。

を使用して、変更された仕様を再ロードします。

プライベート OpenAPI 仕様(英語)を追加するには、API キーを指定します。

自己ホスト型 SwaggerHub オンプレミス(英語)インスタンスから OpenAPI 仕様を追加するには、インスタンスの URL を指定します。

OpenAPI 仕様の比較

新しい仕様バージョンがある場合は、古いバージョンと比較して、互換性があることを確認する必要があります。 1 つの方法は、差分 Ctrl+D を見て、変更された行を比較することです。ただし、すべての変更が互換性にとって重要であるとは限りません。 JetBrains Rider は、OpenAPI 仕様の構造を比較し、変更されたパス、パラメーター、レスポンス、互換性を損なう可能性のある他の要素の概要を作成できます。

プロジェクトツールウィンドウで、2 つの OpenAPI 仕様ファイルを選択し、右クリックして OpenAPI 仕様の比較を選択します。

これにより、変更された仕様要素の要約を含む Markdown ファイルが生成されます。エディター内でファイルが開き、変更を簡単に移動できるプレビューパネルが表示されます。最初に選択したファイルと比較して、2 番目に選択したファイルの変更が表示されます。

OpenAPI 仕様からコードを生成する

有効な OpenAPI 仕様を開いていると、JetBrains Rider はそこからコードを生成することを提案します：

ガターでをクリックし、「openapi ファイル」を実行を選択します。 JetBrains Rider は、指定された場所にソースコードファイルを生成し、ファイルを開く、または別モジュールとしてプロジェクトにインポートするオプション付きの通知を表示します。

Swagger Codegen 実行構成

JetBrains Rider は、特定のファイルで初めてコード生成を実行する際に、 OpenAPI/Swagger コードジェネレーター実行構成を作成します。実行構成を変更するには、実行 | 実行構成の編集を開いて必要な構成を選択するか、ガターでをクリックして実行構成の変更を選択します。

OpenAPI/Swagger コードジェネレーター実行構成の上部で、次の共通オプションを構成できます。

一般的なパラメーター

項目	説明
名前(N)	実行構成の名前を指定して、編集または実行時に他の構成の間ですばやく識別できるようにします。
プロジェクトファイルとして保存(S)	実行構成設定を含むファイルを保存して、他のチームメンバーと共有します。デフォルトの場所は .idea/runConfigurations です。ただし、 .idea ディレクトリを共有したくない場合は、プロジェクト内の他のディレクトリに構成を保存できます。デフォルトでは無効になっており、JetBrains Rider は実行構成設定を .idea/workspace.xml に保存します。

項目

説明

名前(N)

実行構成の名前を指定して、編集または実行時に他の構成の間ですばやく識別できるようにします。

プロジェクトファイルとして保存(S)

実行構成設定を含むファイルを保存して、他のチームメンバーと共有します。デフォルトの場所は .idea/runConfigurations です。ただし、 .idea ディレクトリを共有したくない場合は、プロジェクト内の他のディレクトリに構成を保存できます。

デフォルトでは無効になっており、JetBrains Rider は実行構成設定を .idea/workspace.xml に保存します。

コード生成設定

項目	説明
出力ディレクトリ	生成されたファイルのディレクトリへのパス。
コードジェネレーター	コードジェネレーターの種類： OpenAPI ジェネレーター 7 OpenAPI ジェネレーター 6 OpenAPI ジェネレーター 5 OpenAPI ジェネレーター 4 Swagger コード生成 3 Swagger コード生成 2
言語	生成されたコードのターゲット言語。

項目

説明

出力ディレクトリ

生成されたファイルのディレクトリへのパス。

コードジェネレーター

コードジェネレーターの種類：

OpenAPI ジェネレーター 7
OpenAPI ジェネレーター 6
OpenAPI ジェネレーター 5
OpenAPI ジェネレーター 4
Swagger コード生成 3
Swagger コード生成 2

言語

生成されたコードのターゲット言語。

オプションを変更

一部の設定が非表示になっている場合は、オプションを変更(M) をクリックして表示します。

項目	説明
仕様のパス	OpenAPI 仕様へのパス。
JRE	Swagger Codegen の実行に使用する Java ランタイム
カスタムテンプレートパス	Mustache テンプレート(英語)のあるディレクトリへのパス。

生成パラメーター

ターゲット言語に応じて構成パラメーターを指定します。詳細については、 swagger-codegen/README.md(英語) を参照してください。

HTTP クライアントで OpenAPI 仕様をテストする

OpenAPI 仕様ファイルを扱う場合、指定したエンドポイントへの HTTP リクエストを作成し、組み込みの HTTP client で実行できます。

エンドポイントへの HTTP リクエストを作成する

OpenAPI 仕様ファイルで、エンドポイント定義の横にあるエディターのガターでをクリックします。
または、表示 | ツールウィンドウ | エンドポイントを開き、エンドポイントを右クリックして、 HTTP クライアントでリクエストを生成するを選択します。

JetBrains Rider は新しい HTTP リクエストを作成し、 generated-requests.http スクラッチファイルに保存します。

リクエストをエンドポイントにすぐに送信し、保存したくない場合は、エンドポイントツールウィンドウの HTTP クライアントタブを使用できます。

JetBrains Rider は、利用可能な OpenAPI 仕様に基づき、リクエスト URL およびリクエストボディ（JSON 形式）の補完を提供します。これはローカルだけでなくリモート仕様にも適用されます（補完を有効化するには IDE 設定に追加してください）。

エンドポイントとその使用箇所の名前を変更する

Rename リファクタリングを使って、定義されたエンドポイントと HTTP リクエストでの利用箇所を同時にリネームできます。

以下のいずれかを行います：
- OpenAPI 仕様ファイルで、名前を変更するエンドポイントの定義にキャレットを置きます。
- HTTP リクエストファイルで、名前を変更する URL パスセグメントにキャレットを置きます。
メインメニューまたはコンテキストメニューからリファクタリング | 名前の変更を選択するか、 Shift+F6 を押します。
開いた名前変更ダイアログで、新しいエンドポイントの名前を指定します。
プレビューと変更の適用

JetBrains Rider はエンドポイントとその使用箇所の名前を変更します。

2026 年 6 月 12 日