OpenAPIエディター＆ビューアー

OpenAPIエディター＆ビューアーは、OpenAPI（旧Swagger）仕様ドキュメントを 編集・可視化するための無料ブラウザベースツールです。新しいREST APIの設計や 既存APIのレビューに、YAMLまたはJSONソースと並べてエンドポイント、 リクエストパラメータ、レスポンスコード、データスキーマのライブプレビューを 提供します。

すべての処理はブラウザ内で完全に行われます。API仕様がデバイスから送信される ことはなく、サーバーとの通信、ログ記録、入力に対するサードパーティの 分析はありません。これにより、内部APIの設計、独自スキーマ、プライベート インフラを参照する仕様にも安全に使用できます。

エディターはYAMLとJSONの両方の入力モードをサポートしています。お好みに 応じて切り替えられます。ライブプレビューパネルは、色分けされたHTTPメソッド バッジ（GETは緑、POSTは青、PUTはオレンジ、DELETEは赤）付きのエンドポイント、 展開可能なパラメータテーブル、リクエストボディ参照、レスポンスステータス コードをレンダリングします。components/schemas セクションのスキーマは 各フィールドの名前、型、フォーマット、必須かどうかを表示する展開可能な カードとして表示されます。

関連するデータフォーマットを扱う場合、ここに貼り付ける前にYAMLを整理するのに YAMLフォーマッターが便利かもしれません。また、 サンプルJSONペイロードからスキーマを作成するには JSONスキーマジェネレーターをお試しください。 JSONとYAMLの変換にはJSON-YAML変換ツールをご利用ください。

3つのサンプル仕様（Petstore、Todo API、ユーザー管理API）が含まれており、 YAMLを書かずにすぐにツールを試せます。コピーとダウンロードボタンで 編集した仕様をワンクリックでエクスポートできます。

1. 上部のトグルボタンで入力モード（YAMLまたはJSON）を選択します。
2. 左側のエディターパネルにOpenAPI仕様を貼り付けるか、サンプルバッジ（Petstore、Todo API、User API）をクリックしてデモ仕様を読み込みます。
3. 右側のライブプレビューパネルにAPI情報、エンドポイント、スキーマが即座にレンダリングされます。
4. エンドポイント行をクリックして展開し、パラメータ、リクエストボディ、レスポンスの詳細を確認します。
5. スキーマカードをクリックして展開し、個々のフィールド、型、必須マーカーを確認します。
6. コピーボタンまたはCtrl+Shift+Cで仕様をクリップボードにコピーします。
7. ダウンロードをクリックして仕様を.yamlまたは.jsonファイルとして保存します。
8. クリアをクリックしてエディターとプレビューパネルをリセットします。