OpenAPI

OpenAPI 仕様を作成

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

OpenAPI 仕様を手動で作成

1. プロジェクト ツールウィンドウで Alt+Insert を押し、コンテキストメニューから OpenAPI 仕様 を選択します。

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

   

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

IDE 設定の 言語 & フレームワーク | OpenAPI 仕様 で ガターアイコンを 仕様のクイック編集用ガターアイコン チェックボックスで無効化できます。

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

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

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

OpenAPI 3.0 では、 $ref キーワードを使用して任意の場所にある定義を参照できます。 RubyMine はパス補完、バリデーション、クイックナビゲーションを提供します。 補完には、RubyMine がカレントファイルや外部ファイルのコンテキストを理解し、関連する要素へのポインターを提案します。

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

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

Ctrl+B を押すと、参照先のファイルや要素へすぐに移動できます。

OpenAPI 仕様をプレビュー

統合された Swagger UI または Redoc UI を利用して OpenAPI 仕様をプレビューできます。 OpenAPI 仕様ファイルをエディターで開いたとき、右上の と でプレビューの表示・非表示を切り替えます。

Swagger UI と Redoc UI を切り替えるには、プレビュー領域にマウスカーソルを合わせ をクリックします。

リモート OpenAPI 仕様を追加

プロジェクトの OpenAPI 仕様で定義したエンドポイント URL は、 コード補完で使用できます。 外部仕様用のクライアントコードを作成する際は、エンドポイント URL の補完用にそのファイルをプロジェクトへ追加する必要はありません。 関連するリモート仕様へのリンクを追加できます。

1. 設定 ダイアログ（Ctrl+Alt+S ）で、 言語 & フレームワーク | OpenAPI 仕様 を選択します。

2. を リモート仕様 リストでクリックし、OpenAPI 仕様ファイルの URL を指定するか、 SwaggerHub で OpenAPI 仕様を検索します。

を使用して変更された仕様を再読み込みします。

プライベート OpenAPI 仕様 を追加するには、API キーを入力してください。

セルフホスト型 SwaggerHub On-Premise インスタンスから OpenAPI 仕様を追加するには、インスタンスの URL を指定してください。

OpenAPI 仕様の比較

新しい仕様バージョンがある場合、古いバージョンと比較して互換性があるか確認することが推奨されます。 diff Ctrl+D で変更された行を比較する方法があります。 ただし、すべての変更が互換性に影響するわけではありません。 RubyMine は OpenAPI 仕様の構造を比較し、パス、パラメーター、レスポンスなど互換性を損なう可能性のある変更点の概要を作成できます。

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

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

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