OASからのconnector生成 ​

OASから開始することで、connector構築を迅速化できます。 OAS生成ツールを使用すると、認証とアクションがあらかじめ構築されたconnectorをOASから直接作成できます。

OAS生成ツールの使用 ​

OAS生成ツールは、新しいcustom connectorを作成する場合にのみ使用できます。

1. OASを指定してconnectorを作成するオプションを選択します。

2. OASはファイルを直接アップロードして指定するか、OAS仕様への公開URLを指定します。 OASを指定した後、connectorの名前を調整し、そのロゴを指定できます。 これらは、接続先のアプリケーションをユーザーが識別するのに役立つため重要です。

3. 使用可能な認証方法のリストから認証タイプを選択し、生成されるconnectorに含めるアクションを選択します。

アクションを選択して続行すると、Workatoがリクエストを解析し、生成されたconnectorを返します。

WorkatoがOASドキュメントからconnectorを生成する仕組み ​

WorkatoのSDKでは、どのconnectorにも主な機能が4つあり、それぞれがOASの異なる部分にマッピングされます。

Servers

`connection`および`base_uri`内のフィールド

`security_schemes`

`connection`内のフィールドと認証ロジック

Path items

個々のアクション、各アクションの入力と出力用のobject_definitions、およびmethods

Components

関連するアクションによって参照される`Object_definitions`

生成されたconnectorの仕組み ​

生成される各アクションは、OASドキュメントの詳細に由来します。 各アクション内では、input_fieldsが、APIエンドポイントで必要なすべてのフィールドを含むobject_definitionsを参照していることを確認できます。 これには、headers、cookies、query parameters、およびrequest payload内の値の入力が含まれます。 また、成功した呼び出しに対して想定されるすべてのresponse payload属性を含むobject_definitionを参照するoutput_fieldsも含まれます。

各object_definition内で、Workatoスキーマに見慣れない追加属性が含まれている場合があります。 これらはOASから保持された特別な属性であり、connectorが適切なAPIリクエストの作成方法を理解するための重要なマーカーです。

生成されたconnectorのテスト ​

connectorが生成された後は、レシピで使用する前に必ずテストしてください。 connectorでは、Source codeタブの下にあるWorkatoのSDKテストコードタブを使用します。 コネクション用に生成されたコードが想定どおりに動作し、アクションも想定どおりに動作することを確認します。

レシピでconnectorの最新バージョンの使用を開始する準備ができたら、まずリリースする必要があります。 右上隅にある"最新バージョンをリリース"をクリックします。 その後、ワークスペース内のすべてのユーザーがレシピでこのconnectorの使用を開始できます。

次の予定 ​

connectorを改善するための手順は、ほかにも多数あります。 connectorの拡張の詳細をご確認ください。

トラブルシューティング/FAQ ​