# OpenAPI​​

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com/ja-jp/help/clion/llms.txt).

> **TL;DR**
> 必須プラグイン: [OpenAPI Specifications](https://plugins.jetbrains.com/plugin/14394-openapi-specifications/)

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

CLion は YAML および JSON ファイル内の OpenAPI 定義に対するコーディング支援を提供し、OpenAPI 仕様に基づきサーバースタブ、クライアントライブラリ（SDK）、ドキュメントを生成するために [Swagger Codegen](https://swagger.io/docs/open-source-tools/swagger-codegen/) との統合を行います。

> **Note:**
> CLion は OpenAPI Specification バージョン 2.0、3.0、3.1 をサポートしています。 バージョン 3.2 はサポートされていません。

## OpenAPI 仕様を作成する

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

Procedure: OpenAPI 仕様を手動で作成する

1. プロジェクト   ツールウィンドウで `Alt+Insert` (Windows), `⌘ N` (macOS), `⌃ N` (IntelliJ IDEA Classic (macOS)), `⌘ N` (macOS System Shortcuts), `Alt+Insert` (XWin), `Alt+Insert` (GNOME), `Alt+Insert` (KDE), `Alt+Insert` (Emacs), `Ctrl+N` (Sublime Text), `⌘ N` (Sublime Text (macOS)), `⌘ N` (Xcode), `Ctrl+N` (Visual Studio), `⌘ N` (Visual Studio (macOS)), `Alt+Insert` (ReSharper), `⌥ Insert` (ReSharper (macOS)), `Alt+Insert` (QtCreator), `Alt+Insert` (QtCreator (macOS)), `Alt+Insert` (NetBeans), `Alt+Insert` (Eclipse), `⌘ N` (Eclipse (macOS)) を押し、コンテキストメニューから   OpenAPI 仕様   を選択します。

2. ファイルの名前を指定し、仕様バージョンとファイルフォーマットを選択します。

![新しい OpenAPI 仕様](https://resources.jetbrains.com/help/img/idea/2026.3/openapi_create_new_specification.png)

エディターで開いた OpenAPI 仕様では、 ![アイコンを追加](https://resources.jetbrains.com/help/img/idea/2026.3/app-client.expui.general.add.svg) ガターアイコンを使用して仕様セクションをすばやく追加します。

![OpenAPI gutter icons](https://resources.jetbrains.com/help/img/idea/2026.3/openapi_gutter_icons_add.animated.gif)

IDE 設定の  `言語 & フレームワーク | OpenAPI 仕様`  で   迅速な仕様編集のためのガターアイコン   チェックボックスを使用して、 ![アイコンを追加](https://resources.jetbrains.com/help/img/idea/2026.3/app-client.expui.general.add.svg) ガターアイコンを無効にすることができます。

選択したフォーマットとバージョンに応じて、事前設定された [ファイルテンプレート](using-file-and-code-templates.html)のいずれかが新しい OpenAPI 仕様ファイルに使用されます。

空の YAML または JSON ファイルから始める場合は、  `opnp`  または  `swag`  と入力し、 `Tab` (Windows), `⇥` (macOS), `⇥` (IntelliJ IDEA Classic (macOS)), `⇥` (macOS System Shortcuts), `Tab` (XWin), `Tab` (GNOME), `Tab` (KDE), `Tab` (Emacs), `Tab` (Sublime Text), `⇥` (Sublime Text (macOS)), `⇥` (Xcode), `Tab` (Visual Studio), `⇥` (Visual Studio (macOS)), `Tab` (ReSharper), `⇥` (ReSharper (macOS)), `Tab` (QtCreator), `⇥` (QtCreator (macOS)), `Tab` (NetBeans), `Tab` (Eclipse), `⇥` (Eclipse (macOS)) を押して対応する [ライブテンプレート](using-live-templates.html)を挿入できます。

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

OpenAPI 3.0 では、 [$ref(英語)](https://swagger.io/docs/specification/using-ref/) キーワードを使用して、任意の場所でホストされている定義を参照できます。 CLion はパス補完、検証、迅速なナビゲーションを提供します。 補完のために、CLion は現在のファイルおよび外部ファイルのコンテキストを理解し、関連要素へのポインターの使用を提案します。

1. `$ref`  キーワードを入力します。

2. 外部定義へのパスの入力を開始します。

`Ctrl+B` (Windows), `⌘ B` (macOS), `⌘ B` (IntelliJ IDEA Classic (macOS)), `⌘ B` (macOS System Shortcuts), `Ctrl+B` (XWin), `Ctrl+B` (GNOME), `Ctrl+B` (KDE), `Ctrl+Alt+G` (Emacs), `F12` (Sublime Text), `F12` (Sublime Text (macOS)), `⌘ Click` (Xcode), `F12` (Visual Studio), `F12` (Visual Studio (macOS)), `Ctrl+B` (ReSharper), `⌘ B` (ReSharper (macOS)), `F2` (QtCreator), `F2` (QtCreator (macOS)), `Ctrl+B` (NetBeans), `F3` (Eclipse), `F3` (Eclipse (macOS)) を押すと、参照するファイルと要素にすばやく移動できます。

![OpenAPI use ref](https://resources.jetbrains.com/help/img/idea/2026.3/openapi_ref.animated.gif)

## OpenAPI 仕様をプレビューする

統合された Swagger UI または Redoc UI を使用して、OpenAPI 仕様をプレビューできます。 OpenAPI 仕様ファイルがエディターで開かれている場合、右上隅の ![Open エディター プレビュー ボタン](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.previewOnly.svg) および ![エディターのみ ボタン](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.editorOnly.svg) を使用してプレビューを表示または非表示にします。

Swagger UI と Redoc UI を切り替えるには、プレビュー領域にカーソルを置き、 ![表示切り替え](https://resources.jetbrains.com/help/img/idea/2026.3/app-client.actions.properties.svg) をクリックします。

Swagger​​:

![Swagger プレビュー](https://resources.jetbrains.com/help/img/idea/2026.3/openapi_preview_swaggerui.png)

Redoc​​:

![Swagger プレビュー](https://resources.jetbrains.com/help/img/idea/2026.3/openapi_preview_redocui.png)

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

デフォルトで、エディターとプレビューは垂直（並列）に分割され、ワイドモニターに便利です。 また、水平方向に分割して、プレビューをエディターの下部に表示することもでき、縦長ディスプレイに便利です。

1. エディターの右上隅にある ![Open エディター プレビュー ボタン](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.editorPreview.svg) をクリックして、   エディタープレビュー   ペインを開きます。

2. ![Open エディター プレビュー ボタン](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.editorPreviewVertical.svg) をクリックして、エディターとプレビューを水平に分割します。

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

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

Procedure:

1. 設定   ダイアログ（ `Ctrl+Alt+S` (Windows), `⌘ Comma` (macOS), `⌘ Comma` (IntelliJ IDEA Classic (macOS)), `⌘ Comma` (macOS System Shortcuts), `Ctrl+Alt+S` (XWin), `Ctrl+Alt+S` (GNOME), `Ctrl+Alt+S` (KDE), `Ctrl+Alt+S` (Emacs), `Ctrl+Alt+S` (Sublime Text), `⌘ Comma` (Sublime Text (macOS)), `⌘ Comma` (Xcode), `Ctrl+Alt+S` (Visual Studio), `⌘ Comma` (Visual Studio (macOS)), `Ctrl+Alt+S` (ReSharper), `⌘ Comma` (ReSharper (macOS)), `Ctrl+Alt+S` (QtCreator), `⌘ Comma` (QtCreator (macOS)), `Ctrl+Alt+S` (NetBeans), `Ctrl+Alt+S` (Eclipse), `⌘ Comma` (Eclipse (macOS)) ）で、  `言語 & フレームワーク | OpenAPI 仕様`  を選択します。

2. リモート仕様   リストで ![追加ボタン](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.add.svg) をクリックして、OpenAPI 仕様ファイルの URL を指定するか、 [SwaggerHub(英語)](https://app.swaggerhub.com/) で OpenAPI 仕様を見つけます。

![OpenAPI 仕様の設定](https://resources.jetbrains.com/help/img/idea/2026.3/ac_openapi_remote_spec.png)

![Reload All Specifications ボタン](https://resources.jetbrains.com/help/img/idea/2026.3/app.actions.refresh.svg) を使用して、変更された仕様を再ロードします。

[プライベート OpenAPI 仕様(英語)](https://app.swaggerhub.com/help/apis/public-and-private-apis)を追加するには、API キーを指定します。

自己ホスト型 [SwaggerHub オンプレミス(英語)](https://app.swaggerhub.com/help/enterprise/index)インスタンスから OpenAPI 仕様を追加するには、インスタンスの URL を指定します。

## OpenAPI 仕様の比較

新しい仕様バージョンがある場合は、古いバージョンと比較して、互換性があることを確認する必要があります。 1 つの方法は、 [差分](comparing-files-and-folders.html#comparing_files) `Ctrl+D` (Windows), `⌘ D` (macOS), `⌘ D` (IntelliJ IDEA Classic (macOS)), `⌘ D` (macOS System Shortcuts), `Ctrl+D` (XWin), `Ctrl+D` (GNOME), `Ctrl+D` (KDE), `Ctrl+D` (Emacs), `Ctrl+D` (Sublime Text), `⌘ D` (Sublime Text (macOS)), `⌘ D` (Xcode), `Ctrl+D` (Visual Studio), `⌘ D` (Visual Studio (macOS)), `Ctrl+D` (ReSharper), `⌘ D` (ReSharper (macOS)), `Ctrl+D` (QtCreator), `⌘ D` (QtCreator (macOS)), `Ctrl+D` (NetBeans), `Ctrl+D` (Eclipse), `⌘ D` (Eclipse (macOS)) を見て、変更された行を比較することです。 ただし、すべての変更が互換性にとって重要であるとは限りません。 CLion は OpenAPI 仕様の構造を比較し、変更されたパス、パラメーター、レスポンス、互換性を損なう可能性があるその他の要素の概要を作成できます。

Procedure:

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

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

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

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

![OpenAPI 仕様に基づいてコードを生成する](https://resources.jetbrains.com/help/img/idea/2026.3/openapi-codegen.png)

ガターで ![the Run button](https://resources.jetbrains.com/help/img/idea/2026.3/app-client.expui.gutter.run.svg) をクリックし、   「openapi ファイル」を実行   を選択します。 CLion は指定された場所にソースコードファイルを生成し、ファイルを開くまたは別モジュールとしてプロジェクトにインポートするオプションを含む通知を表示します。

### Swagger Codegen 実行構成

CLion は、特定のファイルで初めてコード生成を実行したときに   OpenAPI/Swagger コードジェネレーター​​.   [実行構成](run-debug-configuration.html)を作成します。 実行構成を変更するには、  `実行 | 実行構成の編集​`  を開いて必要な構成を選択するか、ガターで ![the Run button](https://resources.jetbrains.com/help/img/idea/2026.3/workspace.xml` に保存します。     |

#### コード生成設定

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

#### オプションを変更

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

|  項目  |  説明  |
| --- | --- |
|    仕様書パス    |  OpenAPI 仕様へのパス。  |
|    JRE    |  Swagger Codegen の実行に使用する Java ランタイム  |
|    カスタムテンプレートパス    |  [Mustache テンプレート(英語)](https://mustache.github.io/)のあるディレクトリへのパス。  |

#### 生成パラメーター

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

