REST API を使用した統合ソリューションの開発

REST API を使用して、HTTP クライアントによる呼び出しが可能な RESTful Web サービスとして、統合を公開します。

1. 関連トピックのステップを実行して、 IBM Integration Toolkit で REST API を作成します。
   • Swagger に基づく REST API の場合は、以下のいずれかのトピックにあるステップを実行します。
     • IBM App Connect Enterprise ツールキットを使用して、Swagger仕様書に基づきREST APIを一から作成する。
     • インポートされた Swagger 文書からの REST API の作成。
   • OpenAPI 3.0に基づく REST API の場合は、以下のいずれかのトピックのステップを実行します。
     • IBM App Connect Enterprise Toolkit を使用して、 OpenAPI 3.0 の仕様に基づき、REST API を一から作成する。
     • インポートした OpenAPI 3.0 文書からの REST API の作成

     Swagger 文書をインポートする場合は、 Swagger 文書の制限で説明されているように、REST API の作成に使用される Swagger 文書の形式に関する制限に注意してください。

     REST API が OpenAPI 3.0 文書に基づいている場合は、REST API の作成に使用される OpenAPI 3.0 文書の形式に関する制約事項に注意してください。 詳しくは、 OpenAPI 3.0 の資料に関する制約事項を参照してください。

2. IBM App Connect Enterprise ツールキットのREST APIエディタを使用してREST APIをゼロから作成した場合は、次にREST API内のリソース、モデル、および操作を定義する必要があります。
   • Swagger に基づく REST API の場合は、 REST API エディターを使用した REST API でのリソース、モデル、および操作の定義のステップに従います。
   • OpenAPI 3.0に基づく REST API の場合は、 OpenAPI エディターを使用した REST API でのリソース、モデル、および操作の定義のステップに従います。
   ただし、インポートした Swagger 文書から REST API を作成した場合は、このステップを無視してステップ 3 に進むことができます。
3. 次の関連トピックで説明されているように、各操作をサブフローとして REST API で実装します。
   • Swagger に基づく REST API の場合は、 Swagger 2 文書用の REST API エディターを使用した REST API での操作の実装に従ってください。
   • OpenAPI 3.0に基づく REST API の場合は、 OpenAPI 3.0 文書に基づく REST API の操作の実装に従ってください。
4. オプション: REST API でのエラー・ハンドラーの実装で説明されているように、一連のサブフローとして REST API のエラー処理を実装します。
5. オプション： HTTPS を使用してクライアントとサーバー間の通信を暗号化し、REST API を保護します。詳細は 、「 HTTPS を使用した REST API の保護 」を参照してください。
6. オプション: HTTP 基本認証を使用した REST API の保護」の説明に従って、 HTTP 基本認証を使用してユーザーを認証し、REST API を保護します。
7. （任意）：REST APIをWebブラウザ上で実行される クライアントサイドのコードから利用する場合、 クロスオリジンリソース共有 （ CORS ）の設定が必要になる場合があります。 詳しくは、 Web ブラウザーでの Cross-Origin Resource Sharing を使用した REST API へのアクセスの許可を参照してください。
8. オプション: REST API は、JSON データを処理するようにデフォルトで構成されています。 REST API で非 JSON データを処理する場合は、 REST API での非 JSON データの処理を参照してください。