1. Homepage
  2. Design Center

  3. API Designer

API Designer

API Designer Web UI を使用して、次の API 仕様を設計できます。

  • RESTful API Modeling Language (RAML) バージョン 0.8 または 1.0

  • OpenAPI 仕様 (OAS) バージョン 2.0 または 3.0

  • AsyncAPI 2.0

RESTful API Modeling Language (RAML) バージョン 0.8 または 1.0 の API フラグメントも設計できます。

テキストエディターまたはビジュアルエディターを使用した設計

API 仕様を作成するには、テキストエディターまたはビジュアルエディターを使用できます。

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

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

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

  • Exchange からルールセットを適用して、プロジェクトのガバナンス準拠を検証する。

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

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

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

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

ドキュメントの追加および表示

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

モッキングサービスを使用したテスト

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

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

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

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

Exchange および API Manager での共有

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

MuleSoft 製品全体での仕様やフラグメントの使用

API Designer で設計した仕様やフラグメントを統合された MuleSoft 製品で使用できます。

  • API Designer を使用して API 仕様や RAML フラグメントを設計する。

  • Exchange でホストされているアセットを RAML 仕様で使用する。

  • API 仕様の反復と最終バージョンを Anypoint Exchange にパブリッシュする。

  • API Designer で設計された仕様を Anypoint Studio および API Manager にインポートする。

  • API Designer から Anypoint Studio に仕様を直接インポートする。

関連情報