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

API Designer のビジュアル API エディタを使用して、RAML 1.0、OAS 2.0 または 3.0 (JSON) で API 仕様をスキャフォールディングできます。これを行うには、言語に依存しないフォームを入力します。

開始する前に

Anypoint Platform で、自分のユーザ ID に ​Design Center 開発者​権限を割り当てておく必要があります。

このタスクについて

ビジュアル API エディタは 3 つのパネルに分かれています。

左側のパネル

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

中央のパネル

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

右側のパネル

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

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

手順

  1. Design Center の ​[Projects (プロジェクト)]​ ページで、​[Create new (新規作成)]​ をクリックします。

  2. [New API Spec (新しい API 仕様)]​ を選択します。

  3. [New API Spec (新しい API 仕様)]​ ダイアログで、プロジェクトに名前を付けます。

    名前は後で必要に応じて変更できます。

  4. [Guide me through it (手順に従って操作)]​ オプションを選択して、ビジュアル API エディタを使用します。

  5. [Create API Spec (API 仕様を作成)]​ をクリックします。

結果:

+ ビジュアル API エディタが開きます。

+ 作業中は、モッキングサービスを実行して、API 仕様のコールをシミュレートできます。詳細については、このトピックの最後にある​「関連情報」​にある「API コールのシミュレーション」を参照してください。

+ 仕様を直接編集またはカスタマイズする (RAML フラグメントをインポートするなど) 必要がある場合は、​[Edit RAML (RAML を編集)]​ または ​[Edit OAS (OAS を編集)]​ をクリックすると、いつでも API エディタに切り替えることができます。ただし、一度切り替えた後は、ビジュアル API エディタに戻って API 仕様の作成を継続することはできません。

次のステップ

API 仕様が完成したら、RAML 1.0 形式で Exchange にパブリッシュすることができます。​「API 仕様のパブリッシュ」​を参照してください。

また、​[Edit RAML (RAML を編集)]​ または ​[Edit OAS (OAS を編集)]​ をクリックして、API エディタで仕様をカスタマイズできます。

Was this article helpful?

💙 Thanks for your feedback!