レシピ関数とAPIレシピへの移行

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

以前は、callable recipeタイプとCallable Recipes by Workatoコネクターが、APIエンドポイントと再利用可能なレシピコンポーネントの両方を作成するために使用されていました。 各ユースケース専用のレシピタイプが用意されたため、代わりにレシピ関数API platformコンポーネントを使用してください。

このガイドでは、以下について説明します。


既存の呼び出し可能なレシピへの影響

2021年12月3日以降、新しい呼び出し可能なレシピは作成できません。 既存の呼び出し可能なレシピは引き続き動作し、新しいレシピから呼び出すことができます。 新しいレシピタイプに移行することも、既存の呼び出し可能なレシピの使用を継続することもできます。


呼び出し可能なレシピの変換

既存の呼び出し可能なレシピを新しいレシピタイプに自動変換する方法はありませんが、その必要はありません。 お使いの呼び出し可能なレシピはこれまでどおり動作し続けます。

ただし、新機能を活用したい場合は、新しいレシピタイプへの移行を検討してください。 例: APIエンドポイントとして機能するレシピでは、APIレシピタイプを使用して非標準のレスポンスコードを定義できるようになりました。


新しいレシピタイプの理解

呼び出し可能なレシピのすべての機能は、2つの新しいレシピタイプに分割されました。 呼び出し可能なレシピで実行できたことはすべて、レシピ関数API platformコンポーネントでも引き続き実行できます。

レシピ関数

レシピ関数コネクターは、レシピの再利用性、可読性、および保守に重点を置いています。 レシピ関数は、最小限のオーバーヘッドで再利用可能なレシピコンポーネントを構築するための、シンプルで効率化された方法を提供します。

このコネクターのトリガーとアクションを使用すると、ワークフローを一度構築し、ワークスペース内の複数のレシピで簡単に再利用できます。 詳細はレシピ関数ドキュメントを参照してください。

APIレシピ

API platformコネクターは、自動化をAPIエンドポイントとして作成し、デプロイすることに特化しています。 APIレシピには、OpenAPI Specificationの全機能を利用して構築できるようにする新機能が含まれています。これには次が含まれます:

  • カスタムリクエストヘッダーとレスポンスヘッダー
  • 複数のレスポンスとすべてのHTTPレスポンスコードのサポート
  • レスポンスを送信すると、現在のジョブが自動的に停止します

このリリースにより、APIがWorkatoエコシステムで第一級の機能として扱われることが確認され、改善された自動ドキュメント化や、有効な任意のOpenAPI SpecificationからAPIコレクションを自動生成する機能など、今後のさらなる改善の基盤が築かれます。 詳細はAPI platformドキュメントを参照してください。


トリガーとアクションの比較

呼び出し可能なレシピのトリガーとアクションは、新しいAPI platformおよびレシピ関数のトリガーとアクションと完全な互換性があります。

開始する場所が不明な場合 呼び出し可能なレシピバージョンを置き換えるトリガーまたはアクションを探すには、以下の表を使用してください:

呼び出し可能なレシピのトリガーまたはアクション 新しいトリガーまたはアクション
新しい呼び出しトリガー(レシピコンポーネント)レシピ関数:新しい関数呼び出しトリガー
新しい呼び出しトリガー(APIエンドポイント)API platform:新しいAPIリクエストトリガー
レシピ呼び出しアクション(同期)レシピ関数:レシピ関数呼び出しアクション(同期)
レシピ呼び出しアクション(非同期)レシピ関数:レシピ呼び出しアクション(非同期)
レシピからデータを返すアクションレシピ関数:レシピ関数からデータを返すアクション
非同期呼び出しを待機するアクションレシピ関数:非同期呼び出しを待機するアクション

Last updated: