APIのフローをゼロから作成する

APIフローを作成するには、以下の手順を実行する。

1. App Connect ホームページで、「 Create flows for an API 」をクリックする。
   代わりに、 [デザイン] ページ に移動し、 [作成 ] > [API 用のフロー] をクリックします。
   APIエディターは3つのタブで開きます。

   デザイナー

   Designer タブを使用して、API のモデルと操作を作成します。

   OpenAPI

   タブを使用する。 OpenAPI タブを使用すると、 OpenAPI 3.0 仕様に準拠したフォーマットでAPIを表示できます。

   ゲートウェイ

   ユニファイド・オーサリングが有効になっている場合、 ゲートウェイタブを使用して、公開されているAPIを呼び出すためにゲートウェイが使用できるデフォルト設定を確認します。 API Connect. また、このAPIに対して特別なAPIポリシーを適用したり、ゲートウェイやポータルの設定を行ったりすることもできる。

   ユニファイド・オーサリングが無効になっている場合は、 Gateway タブに有効にするための説明があります。

2. オプション： ユニファイド・オーサリングを有効にするには、 Designer タブで Change API gateway settings をクリックし、ユニファイド・オーサリングを有効にしてから Saveをクリックします。
   ユニファイド・オーサリングを有効にすると、APIドキュメントを公開するための設定を確認および編集できます。 これらの設定はステップ15で説明する。
3. フローの目的を示す名前を入力してください。
   

   フローを進めると App Connect は変更を自動的に保存します。 フローから離れると、フローは下書きとして保存され、別の機会に完成させることができます。

4. 作業したいオブジェクトの構造を定義するモデルを作成するには、 Model nameに名前を入力し、 Create modelをクリックします。
   例えば、レコードの作成、取得、更新が可能な顧客オブジェクトが欲しいとします。
   モデルパネルには2つのタブがある。

   プロパティ－

   モデルの構造を定義するには、 「Properties」 タブを使用します。

   操作

   APIがモデルとどのように相互作用するかを定義するには、 「Operations」 タブを使用します。

   
5. Properties タブで、プロパティを設定してモデルの構造を定義する。
   注： 物件には以下の条件と制限があります。

   • 各プロパティ名は一意でなければならない。
   • 名前にはアルファベット、数字、アンダースコアのみを使用する。
   • 名前にスペースは使用できませんが、単語を区切るためにアンダースコア文字（_）を使用することができます。
   • 名前はアルファベットかアンダースコアで始めなければならない。
   1. 最初のプロパティを追加するには、名前を入力し、そのプロパティのデータ型を選択します。
      デフォルトでは、最初に追加するプロパティには ID オプションが選択されています。 フローは、オブジェクトを作成する際にモデルのIDとして指定されたプロパティを返さなければならない。 IDプロパティは、オブジェクトを更新したり取得したりするリクエストでも、そのIDを使って送信されなければならない。 1つのプロパティに対してIDを設定する。

      ヒント： 接続しているアプリケーションからプロパティを追加するには、「 Select properties from applications 」をクリックすることもできます。 適切なアカウントを選択し、1つ以上のプロパティを選択し、 Add propertiesをクリックする。

      
   2. さらにプロパティを追加するには、 Add propertyをクリックします。
      
6. オプション： さらにモデルを作成するには、 Create modelをクリックし、新しいモデルごとにプロパティを追加します。
   モデルの名前を編集したり、モデルを削除するには、メニューから適切なオプションを使用します。

   
7. APIがモデルとどのように相互作用するかを定義するには、 Operationsをクリックします。
   • 組み込み操作の 1 つを追加するには、 [追加する操作を選択] をクリックし、モデルに対して実行する [作成 ]、 [取得]、または [置換または作成] 操作を選択します。
     
   • フィルタを含む操作を選択した場合は、適切なフィルタのプロパティを選択します。 Retrieve model_name with filter 操作では、結果のページ分割設定を有効にして構成することもできます。 ページネーションは、APIが実行されるたびにデータの「ページ」を返すことを可能にする。 limit パラメーターは、返すレコード数を指定する。 skip パラメータは、フローがレコードを返し始める前にスキップするレコード数を指定する。 token パラメータは、APIがどこからレコードを返し始めるかを特定するために使用できる文字列である。
     フィルタを適用するには、モデルの ID プロパティを含む少なくとも2つのプロパティを定義する必要があります。

     

     詳細については、 IBM App Connect の API フローのフィルタパラメータの紹介、および IBM Integration Community の API フローの Retrieve with filter オペレーションのページネーションの設定を参照してください。

   • 独自の操作を定義するには、［ 追加する操作を選択 ］をクリックし、［ カスタム操作を追加 ］を選択します。
     制限事項制限：クエリパラメータはモデル ID と同じにすることはできず、カスタム操作の名前は以下のキーワードのいずれかにすることはできません。

     create, updateOrCreate, replaceOrCreate, findOrCreate, buildNearFilter, all, destroyAll, count, save, update, destroy, delete, remove, replaceById, updateAttributes, patchAttributes, upsertWithWhere, getChangeModel, getIdName, getSourceId, handleChangeError, rectifyChange, replaceById, replaceOrCreate, replicate, updateAll, upsert, upsertWithWhere, destroy, fillCustomChangeProperties, getId, isNewRecord, reload, replaceAttributes, save, setId, updateAttribute, updateAttributes

8. 操作を実行するフローを設定する：
   1. フローを実装する 」をクリックする。
      

      フローエディタには、 Request ノード、 Response ノード、および1つまたは複数のターゲットアプリケーション、インポートされたAPI、またはツールボックスユーティリティを追加するためのスペースを含む基本的なフロー構造が含まれています。 Requestボディの例の構造は、モデルのプロパティといくつかのサンプルデータから構築されます。

      
   2. アプリケーションまたはインポートしたAPIをフローに追加するには、 (+)をクリックしてアプリケーションまたはAPIを選択し、適切なアクションを選択します。
      に正しいアカウントが選択されていることを確認する。 App Connect に正しいアカウントが選択されていることを確認します。 アカウントに接続されていない場合は、「 アカウントに接続する 」の指示に従ってアカウントに接続することができます。
   3. アクションのフィールドに、ターゲット・アプリケーションまたはAPIに渡したい値を入力する。 プレーンテキストで静的データを指定することも、フロー内の前のノードからのマッピングを追加して動的データを指定することもできる。 また、関数（またはJSONata式）を適用してデータを変換したり、他の組み込みメカニズムを使用してカスタム値を定義したりすることもできます。

      テキスト、マッピング、JSONata式を手動で入力したり、独自のカスタム値を定義するには、 アクションの設定を参照してください。

      アクションのフィールドに、提案されたスマートマッピングを自動的に入力するには、マッピングアシストを使用します（ AIを利用した提案によるデータマッピングとデータ変換の簡素化を参照）。

      

      ヒント： 自動生成またはカスタムサンプルデータを使用して、マッピングを追加しながらテストすることができます。 詳細については、 サンプルデータを使ったマッピングのテストを参照してください。 アクションのフィールドが完成したら、サンプルデータを使ってアクションをテストすることもできます。 アクションをテストするには、あなたが接続しているターゲット・アプリケーション上でアクションが完了するため、非運用アカウントを使用していることを確認してください。 詳細については、 サンプルデータを使ったアクションのテストを参照してください。
   4. オプション： さらにアプリケーションやインポートしたAPIを追加する。
   5. オプション： サポートされている1つ以上のツールボックスユーティリティを使用して、特殊な処理を行う。
      例えば、 If ノードを追加して条件処理を提供したり、 For each ノードを追加して検索された項目を処理したりする。 詳細については、 フローに特殊処理を追加する（Toolboxユーティリティ ）を参照してください。
   6. 操作が正常に完了したときに返されるレスポンスを定義するには、フローの「 Response」 ノードをクリックします。
   7. レスポンスヘッダーセクションで、希望するレスポンスステータスコードを指定します。

      作成操作は201（レコード作成）の応答コードを返す。
      Retrieve オペレーションはレスポンスコード200（レコードが取得された）を返す。
      置換または作成操作は、200（レコードが置換された）または201（レコードが作成された）の応答コードを返す。

   8. レスポンス・ボディ・ セクションでは、テキスト、フロー内の前のノードからのマッピング、またはJSONata式を使用して、レスポンス・ボディで返されるフィールドを定義します。
      

      ヒント： オブジェクトを作成する場合、通常、ターゲット・アプリケーションまたはAPIからのIDのみがレスポンス・メッセージで返されます。 オブジェクトを取得する場合、レスポンス・メッセージには、ターゲット・アプリケーションまたはAPIからリクエストしたすべてのフィールドが表示される。

      フロー内のすべてのノードを設定した後、自動生成またはカスタムサンプルデータを使用して、フローを開始する前にフローをテストできます。 フローをテストするときは、本番用ではないアカウントを使用するようにしてください。 フロー内で設定されたアクションは、接続されているターゲット・アプリケーション上で完了する。 詳細については、 サンプルデータを使ったフローのテストを参照してください。

   9. Doneをクリックしてモデルに戻ります。
9. モデルの操作をさらに定義し、各操作を実行するフローを構成する。
   
10. 追加モデルのオペレーションを定義し、そのフローを実装する。
11. オプション： エラーキャッチフローを追加して、APIフローのエラーを処理することができます。
    詳細については、 イベント駆動型フローまたはAPIフローでエラーを処理するためのcatchフローの設定を参照してください。
12. フローをテストまたはデプロイする前に、フローの検証エラーを修正してください。
    詳細は、 フローの検証を参照。
13. オプション： フローのAPI定義を表示するには、 OpenAPI タブをクリックします。
    API定義はフォーム・ビュー に表示されます。 API Connect. このタブの詳細は読み取り専用ですが、APIエディタでフローのモデルや操作を変更すると自動的に更新されます。 フォームビューの「 一般」 カテゴリーはデフォルトで展開されている。 また、以下のカテゴリーも用意されている。 (このビューには、現在適用できないセクションや、APIの詳細が表示されないセクションがあります)

    Components カテゴリには、API定義の様々な側面に関連する再利用可能なオブジェクトが表示される。

    • Schemasは、各モデルとそのプロパティの詳細を表示します。
    • 回答は該当なし。
    • パラメータは適用されない。
    • 例は該当しない。
    • リクエストボディは該当しない。
    • ヘッダーは適用されない。
    • Security Schemes 」には、APIオペレーションを呼び出す際に認証情報（クライアントID）を提供するために使用される、事前に設定されたAPIキーのセキュリティスキームの詳細が表示されます。 セキュリティスキーム名は clientID 、タイプは apiKey で与えられ、 X-IBM-Client-Id パラメータは、APIのリクエストヘッダで認証情報を渡すために使用される。
    • リンクは適用されない。

    

    一般」 カテゴリーには以下のセクションがある。

    • Info セクションにはAPIの概要が記載されている。 このセクションには、タイトルとしてのフロー名、フロー名に基づいて生成され、APIを識別するために使用される名前、および割り当てられたバージョン（通常は 0.0.1 ）が含まれる。 残りのフィールドは空白。
    • Servers "セクションには、ターゲット・サーバーに接続するためのAPIのサーバー定義が表示されます。 APIをテストするとき、APIはデフォルトの統合ランタイムに一時的にデプロイされる。 したがって、APIのエンドポイントは https://default-integration-runtime で始まる：

      https://default-integration-runtime-https-ac0abcd2def.p-vir-d1.appconnect.ibmappdomain.cloud/Bookstore_API

      APIをデプロイすると、APIは作成したランタイムにデプロイされる。 したがって、APIエンドポイントはランタイムの名前で始まる：

      https://my-custom-ir-https-ac0abcd2def.p-vir-d1.appconnect.ibmappdomain.cloud/Bookstore_API

      
    • Security は、API に適用されるセキュリティ要件を表示します。 デフォルトでは、 clientID セキュリティ・スキーム（ apiKey ）が設定されている。
    • 外部ドキュメンテーションは適用されない。
    • タグは適用されない。

    

    Paths カテゴリには、APIフローで定義された各操作のパスが表示されます。 各パスは HTTP 動詞と URL （相対）パスで構成され、APIがどのように公開されるかを定義する。 ナビゲーションペインで URL の各パスをクリックして展開し、さらに詳しく調べることができる。 このカテゴリーには以下のセクションがある。

    • サーバーは対象外。
    • パラメータは適用されない。
    • オペレーションは、オペレーションの種類に応じた詳細を表示する。 例えば、タグ（モデル名に対応）、パスやクエリパラメータ、レスポンスコードや説明が表示されるかもしれません。

    

    ソース をクリックすると、UI で API 定義の基礎となる OpenAPI YAML ソースを表示できます。 このビューも読み込み専用で、YAMLソースは OpenAPI 3.0 仕様に準拠します。

    
14. オプション: ユニファイド・オーサリングが有効になっている場合は、「 ゲートウェイ」 タブをクリックして、ポリシー、ゲートウェイおよびポータル設定を表示および構成します。 ここで設定した内容は、すべて API Connect で実行されているAPIには影響しない。 App Connect.

    ユニファイド・オーサリングが無効になっている場合は、ステップ 16に進んでフローを開始する。

    ポリシー

    このビューを使用してアセンブリ・エディタを表示し、APIをカスタマイズするためのアセンブリを作成します。 アセンブリは、API内の操作の呼び出しや応答に適用される要素（ポリシーや論理構成要素など）で構成されます。 アセンブリエディターには、使用可能なエレメントを一覧表示するパレットがあります。 また、エレメントを設定するために使用されるスライド式のプロパティシートや、アセンブリのエレメントを配置し視覚化するために使用されるキャンバスも含まれています。 詳細については、ドキュメントの 「アセンブリ・エディタ 」、「 API ポリシーとロジック構文 」、「 アセンブリのエラー処理 」を参照してください。 API Connect ドキュメントを参照してください。

    

    最初に Policies ビューを開くと、キャンバスには API を実行するための Invoke ポリシーが 1 つ用意されています。 ゲートウェイはこのポリシーを使って、実行中のAPIを App Connect. クリックすると、このポリシーのプロパティ・シートを開くことができます。 ただし、デフォルトの設定を編集する必要はない。デフォルトの設定には、 HTTP 基本認証用のユーザー名とパスワードも含まれている。 フィールドの変数 app-connect-designer-url URL フィールドの URL。 App Connect インスタンスを表す。 この URL は、 ゲートウェイタブの 「 ゲートウェイとポータル設定 」>「 プロパティ 」で定義される。

    注: APIを呼び出すためにエンドポイント Invoke にアクセスする代替方法を考案できない限り、デフォルトの ポリシー(タイトル Invoke flow)を削除しないでください。 App Connect エンドポイント URL にアクセスして API を呼び出す代替方法を考案できない限り、デフォルトのポリシー ( ) を削除しないでください。 app-connect-designer-url はエンドポイント URL を定義している。

    

    要件に合わせて、パレットから他のポリシーや論理構成を追加することができる。 例えば、APIへの呼び出しを制限するには、 Rate limit ポリシーをアセンブリの適切な位置にドラッグします。 その後、プロパティ・シートを使用して、指定された期間に許可される最大通話数を定義することができます。 詳しくは、 API Connect の「 Rate limit 」を参照。

    ヒント： アセンブリ内でレート制限が定義されている場合、アセンブリ内のそのポイントでのコールにのみ影響します。 プランによってコールの進行が許可されても、アセンブリに設定されたハードリミットを超えると、コールはプロセスフロー内のレートリミットが設定された時点で停止されます。 レートリミットポリシーが完了する前に、アセンブリのプロセスフローに表示されるすべてのアクション。 レート制限ポリシーの後にフローに表示されるアクションのみがキャンセルされる。

    

    ゲートウェイおよびポータルの設定

    このパネルを使用して、APIの一般的な構成設定を表示し、これらの設定の一部を更新します。 詳細については、「 ゲートウェイとポータルの設定の指定 」を参照してください。 API Connect ドキュメントを参照してください。

    

    ヒント: デフォルトの app-connect-designer-url プロパティ（[ ゲートウェイおよびポータル設定 ] > [ プロパティ ]の下）は、ゲートウェイがアクセスに使用する現在のインスタンスの URL を定義します。 App Connect プロパティを定義します。 このプロパティを削除または編集しないでください。

    

15. オプション： ユニファイド・オーサリングが有効になっている場合は、 API Connect のパブリッシング環境設定を行います

    ユニファイド・オーサリングが無効になっている場合は、ステップ 16に進んでフローを開始する。

    フローが停止している場合にのみ、パブリッシング設定を構成または更新できます。 パブリッシング環境設定は、そのフローのみに関連付けられる。

    APIフローの公開設定を行わずにAPIフローを開始した場合、フローに対して最後に保存されたユーザー設定が使用されます。 事前に環境設定が設定されていない場合、API は既定のプランに公開されます。 API Connect インスタンスのサンドボックス・カタログ内の自動生成された製品で、既定のプランに公開されます。

    1. API エディタの Designer タブで、 Change API gateway settings アイコン をクリックします。
       
       APIゲートウェイ設定パネルが開きます。

       

       注： APIフローを自動的に API Connect に公開したくない場合は、このパネルでユニファイド・オーサリングを無効にできます。 ユニファイド・オーサリングを無効にしたり、その他の環境設定を更新したりすることはできません。 選択した環境設定は読み取り専用モードで表示できますが、これらの環境設定を更新したい場合は、フローを停止する必要があります。 フローを停止すると、公開されたAPIは削除されます。 フローを再起動すると、更新された設定に従ってAPIが再公開されます。
    2. ステージングターゲットとランタイム設定 ]で、[ 編集] リンクを使用して、製品（およびAPI）を発行できるステージングターゲットと、発行されたAPIをホストするゲートウェイサービスを定義します。

       ターゲット・カタログ

       APIを含む製品を公開するカタログを指定します。 選択されたカタログは、他の環境設定のスコープとして使用されます。 APIカタログは API Connect ケーパビリティが表示されます。 App Connect ケーパビリティの カタログを選択するには API Connect ケイパビリティからカタログを選択するには、［ その他の環境 ］をクリックします。 のインスタンスでAPIカタログを検出するには API Connect Enterprise as a Service インスタンスと同じ地域の webMethods Hybrid Integration 他の環境] タブに移動し、 [外部検索] をクリックします。

       ターゲット・スペース

       選択したカタログがスペースに分割されている場合は、パブリッシュするスペースを指定します。

       注： 組み込みのサンドボックスカタログを使用することを選択した場合、このカタログではSpacesを有効にできないため、 Target space オプションは表示されません。 スペースにパーティショニングされていない既存のカタログを選択した場合、 ターゲットスペースのオプションも表示されません。

       ターゲット・ゲートウェイ・サービス

       公開された製品とAPIの受信トラフィックを処理するランタイム機能を提供するゲートウェイサービスを指定します。 通常、 datapower-api-gateway ゲートウェイ・タイプを持つ検出されたゲートウェイ・サービスのみが互換性があるとみなされる。

       • すべての互換性のあるゲートウェイ・サービスを使用する： 検出されたすべての互換性のあるゲートウェイサービスを使用するには、このオプションをクリックします。
       • 互換性のあるゲートウェイ・サービスを選択します： このオプションをクリックして、1つまたは複数の互換性のあるゲートウェイサービスを選択します。 (互換性のないゲートウェイ・タイプは無効化される）

       
    3. API消費設定 ]の下にある[ 編集] リンクを使用して、コンシューマー向けのAPIパッケージ化方法とAPI使用量の管理方法を定義します。

       ターゲット製品

       APIを含む製品を指定する。

       • 自動製品を生成します： 自動的に生成された製品を使用するには、このオプションをクリックします。 この製品名は、 APIゲートウェイ設定パネルで API title auto product 。 APIタイトルはフロー名を表します。 (この名前は API Connect インスタンスでは異なります)
       • 既存の製品： 選択したカタログから既存の製品を選択するには、このオプションをクリックします。

       ターゲット製品のレート制限

       自動生成された商品に発行することを選択した場合は、APIへの呼び出しを制御するためにレート制限を設定します。 この料金制限は、自動生成された本商品のデフォルトプランに適用され、プラン内のすべての業務に共有されます。

       • 無制限： 無制限の通話を許可するには、このオプションをクリックします。
       • カスタム： このオプションをクリックすると、期間内の指定コール数を定義できます。

       既存の製品を選択した場合、[ 対象製品レート制限 ] オプションは無効になります。 代わりに、選択された製品とプランで設定されている料金制限が適用されます。

       ヒント: API フローの [ゲートウェイ] タブを使用して、API アセンブリ フローの任意の時点で Rate Limit ポリシーを追加し、API アセンブリでより詳細なレート制限を定義することもできます。

       ターゲット・プラン

       既存の製品を選択した場合は、選択したアプリケーションがサブスクライブして API を利用できる関連プランを選択します。

       自動生成製品への発行を選択した場合、アプリケーションは自動的にこの製品のデフォルト プランに登録され、この設定を変更することはできません。

       テスト・アプリケーション

       選択したプランにサブスクライブして API を利用するアプリケーションを選択します。

       • 内蔵テストアプリケーションを使用する： 付属のテストアプリケーションを使用する場合は、このオプションを選択します。 このオプションは、サンドボックス・カタログを使用することを選択した場合にのみ利用できる。
       • 既存のアプリケーションを選択します： 選択したカタログに手動で作成された既存のアプリケーションを選択するには、このオプションを選択します。 (開発者ポータルサイトがある場合、このアプリケーションは、選択したカタログに関連付けられているポータルに登録されます)

       テスト・コンシューマー組織

       デフォルトでは、選択したアプリケーションを所有するコンシューマー組織がここに表示されます。

       
    4. 「保存」をクリックして設定を保存する。
       あなたのパブリッシング設定は、フローの有効期間中 App Connect. 環境設定は、APIを停止して再起動した場合や、ユニファイド・オーサリングを無効にして再度有効にした場合でも保持されます。
16. フローを実行して、その動作を観察することができる。

のAPIにアクセスするには API Connect にアクセスするには、以下の手順を実行する。

1. API Connect インスタンスで、API Manager UI を開く。
2. ナビゲーションペインで、 管理アイコン をクリックします。
3. Manage ページで、パブリッシュするサンドボックスまたはユーザー定義カタログを選択します。
   Products] タブで、APIを含む公開済みのProductを確認できます。 製品のタイトルと名称は、APIフローから派生したものであり、以下の参照も含まれる。 App Connect. 自動生成された製品にパブリッシュすることを選択した場合、製品のバージョンは 0.0.1 となります。 既存の製品のスタンドアロン バージョンへのパブリッシュを選択した場合、製品のバージョンは継承されます。

   • 自動生成された商品にパブリッシュすることを選択した場合、商品のタイトルは API_flow_name (Created by App Connect Designer) と表示され、名前は api-flow-name-created-by-app-connect-designer と表示されます。
   • 既存の商品にパブリッシュすることを選択した場合、商品タイトルは Product name - API_flow_name (Created by App Connect Designer) と表示され、名前は product-name-api-flow-name-created-by-app-connect-designer と表示されます。

   
4. オプション： APIを（限定的に）使用するには、オプションアイコン（ ）をクリックし、適切なメニューオプションを選択します。
   例えば、 Manage APIsを選択してAPIのベースエンドポイントを表示したり、サブスクリプションを表示したりできます。 また、「 アナリティクス」 タブを使用して、APIコールに関する分析を表示することもできます。
   制限： APIは API Connect の対応するAPIが実行されている間だけAPI Manager UIに存在する。 App Connect が実行されている間だけ存在する。 でAPIを停止すると、商品は自動的にカタログから削除されます。 App Connect でAPIを停止すると、製品は自動的にカタログから削除されます。
5. オプション： 指定したカタログで有効になっている開発者ポータルにアクセスできる場合は、Portal URL （API Managerの Catalog settingsの下）を使用して開発者ポータル・サイトを開きます。
   

   開発者ポータルから API製品をクリックして、公開されているAPI製品を検索します。

   

   タイル上の製品名または API 名をクリックすると、API のプラン詳細や OpenAPI 定義を表示したり、API をテストしたりできます。

   

   詳細については、「 開発者ポータルのAPIと製品 」を参照してください。 API Connect ドキュメントを参照してください。

   制限： 制限：API プロダクトは、対応する API が実行されている間のみ、Developer Portal に存在します。 App Connect が実行されている間のみ、開発者ポータルに存在します。 でAPIを停止すると、API製品は自動的にポータルから削除されます。 App Connect でAPIを停止すると、API製品は自動的にポータルから削除されます。