ビジュアル API エディターでの API 仕様の作成

このパネルには、開発している API 仕様の名前が表示されます。また、提供されているコントロールを使用して、リソース、データ型、およびセキュリティスキームを作成することもできます。これらのコンポーネントは仕様の本文内にすべて含まれ、個別のファイルとして作成されません。

このパネルには、仕様のコンポーネントのプロパティを指定するためのフォームがあります。エディターを初めて開くと、仕様の主要なプロパティを指定し、仕様をドキュメント化するためのフォームが表示されます。左側のパネルで項目の名前をクリックすると、そのフォームが中央のパネルで開きます。

このパネルには、RAML Viewer と OAS Viewer が表示されています。これらは共に参照のみです。パネルの下部にあるタブをクリックすると、これらが切り替わります。これらのビューアーには、仕様の現在のドラフトが RAML 1.0 または OAS 3.0 形式で表示されます。中央のパネルに表示されたフォームに値を入力すると、ドラフトがその値で更新されます。

また、このパネルでは、モッキングサービスを実行して、セットアップしたエンドポイントをテストすることもできます。