API Designer

API Designer には、API 仕様およびフラグメントを設計、ドキュメント化、テスト、共有するための Web ベースのインターフェースがあります。

設計

テキストエディタまたはビジュアルエディタを使用して、API 仕様を RESTful API Modeling Language (RAML) バージョン 0.8 または 1.0 で、もしくは OpenAPI specification (OAS) バージョン 2.0 または 3.0 に準拠して作成できます。

テキストエディタでは、次の作業を行うことができます。

  • 適切なメソッド、リソース、パラメータ、セキュリティコンポーネントを自動入力するコンテキストアウェアシェルフを使用して、ベストプラクティスに従って設計する。

  • Exchange の RAML API フラグメント (セキュリティスキーマやデータ型など) または独自に作成した RAML API フラグメントを含める。

  • 既存の API 仕様をインポートする。

ビジュアルエディタでは、次の作業を行うことができます。

  • RAML フラグメントを含める必要のないユースケースの仕様を作成する。

  • テキストエディタで入力およびカスタマイズできる仕様をスキャフォールディングする。

ドキュメント化

仕様やフラグメントに説明を追加するときに、テキストエディタの右側のペインに自動生成される対話型ドキュメントでそれらを表示できます。

テスト

モッキングサービスを使用して、次の作業を行うことができます。

  • 1 行のコードを作成する前に API の機能をプレビューする。

  • 仕様に要求を送信して、定義された応答を受信する。

  • 動作ヘッダーを使用して、さまざまなシナリオ (タイムアウトやエラーなど) をシミュレーションする。

共有

API 仕様を Anypoint Exchange にパブリッシュして、API Manager、Anypoint Studio、Flow Designer で使用できます。API 仕様を API Manager に直接追加することもできます。

API Designer と他の MuleSoft 製品の関連性

API Designer は、アプリケーションを統合する MuleSoft API 主導のアプローチの不可欠な部分です。次の図は、API Designer で作成した API 仕様を他の MuleSoft 製品で使用する方法を示しています。

apid system overview

仕様の作成者は、API Designer を使用して API 仕様や RAML フラグメントを設計します。RAML 仕様では、Exchange でホストされているアセットを使用できます。仕様の作成者は、反復や最終バージョンを Anypoint Exchange にパブリッシュできます。

仕様は Exchange から Anypoint Studio や Flow Designer に RESTful コネクタとしてインポートしたり、API Manager にインポートしたりできます。Anypoint Studio は、仕様を API Designer から直接インポートすることもできます。

Was this article helpful?

💙 Thanks for your feedback!