OpenAPIドキュメントの編集、検証、およびテストを行います
`OpenAPI 仕様 (OAS) は、プログラミング言語に依存しない形式でウェブ API を記述するための標準です。これは、ソフトウェアアプリケーションがインターネット上でどのように通信するかを説明する設計図として機能します。開発者は、OpenAPI を使用して、API の詳細、エンドポイント、データ、およびセキュリティに関する情報を記述した JSON または YAML 形式の指示を作成します。この標準化された記述により、他のプログラムは API の内部コードを見る必要 없이、API と連携することができます。
XMLSpyには、開発時やAPIの調査時にOpenAPIを扱うための高度なツールが搭載されており、これには検証、編集、テスト機能などが含まれています。
グラフィカルな JSONスキーマエディタ XMLSpyでは、OAS（Open API Specification）に基づいてJSONスキーマの検証と編集が可能です。視覚的なインターフェースにより、開発者は複雑なOpenAPIスキーマを扱いやすくなります。このインターフェースは、構造をグラフィカルに表現することで、理解を深め、エラーや矛盾を特定するのに役立ちます。
JSONスキーマエディタには、OAS拡張機能のサポートが含まれており、具体的には、識別子（discriminator）、XML、フォーマット、および外部ドキュメントなどが含まれます。これらの機能は、「詳細」エントリヘルパーで設定できます。
OpenAPIドキュメントがJSON形式またはYAML形式で記述されている場合でも、XMLSpyに搭載されているテキストベースのOpenAPIエディターは、構文ハイライト、コード折りたたみ、自動補完、入力支援など、高度な編集機能を備えています。
もしグリッド表示に切り替えると、XMLSpyはドキュメントの構造を視覚的に表現し、操作、理解、編集がより容易になります。 高度な編集機能に加えて、グリッド表示では、セル内での操作、視覚的なドラッグ＆ドロップによる編集、およびノードの表示方法を再構成するためのテーブル表示が利用可能です。 また、データのセクションを展開・折りたたむことで、長いファイルを効率的に操作し、特定の要素を簡単に見つけることができます。
テキスト表示とグリッド表示の両方で、ドキュメントがOpenAPI仕様に準拠しているかどうかの検証機能を提供します。
XMLSpyでは、最初から始める場合でも、新しいOpenAPIドキュメントを作成するための組み込みテンプレートが用意されており、Open API 1.0、2.0、および3.0に対応しています。
XMLSpyには、便利な機能が多数含まれています HTTPテストウィンドウ OpenAPIに対応しており、既存のAPIに対してHTTPリクエストを作成し送信するプロセスを、ウィンドウ上で分かりやすく案内します。その後、ウィンドウ内で、受信したレスポンスを確認したり、問題のトラブルシューティングを行ったりすることができます。
OpenAPIドキュメントの場所を指定すると、HTTPテストウィンドウに、利用可能なパスと、それぞれのパスに対応する操作が表示されます。
選択された操作とパラメータに基づいて、XMLSpyはテストメッセージを自動的に生成します。このメッセージをAPIに送信し、その結果を確認することができます。
リクエストを送信し、応答を確認できる機能は、開発および統合段階において、APIが期待通りに動作することを確認するために役立ちます。これは、ご自身のAPIのテストだけでなく、サードパーティのインターフェースの調査にも効果的なツールです。
