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

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

始める前に

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

このタスクについて

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

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

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

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

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

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

手順

  1. Design Center の [Projects (プロジェクト)] ページで、​[Create (作成)] をクリックして [Create API Specification (API 仕様を作成)] をクリックします。

  2. [New API Specification (新しい API 仕様)] ダイアログで、プロジェクトの名前を入力し、​[Try API designer’s visual editing capabilities (API Designer のビジュアル編集機能を試す)] オプションを選択してビジュアル API エディタを開きます。

    結果:

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

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

次にすること

API 仕様が完成したら、RAML 形式で Exchange にパブリッシュすることができます。パブリッシュするには、ビジュアル API エディタの右上隅にある [Publish to Exchange (Exchange へのパブリッシュ)] ボタンをクリックして [Publish API specification to Exchange (Exchange への API 仕様のパブリッシュ)]​ダイアログを開きます。

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

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub