OpenAPI よくある質問

OpenAPI に関するよくある質問（FAQ）への回答をご覧ください。

What is a Swagger file in OpenAPI?

Swagger ファイル は、API の構造を概説する OpenAPI ドキュメントです。Swagger ファイルには次の情報が含まれます：

• Endpoint methods（例えば：GET、POST）
• Endpoint paths（例えば：/pet）
• Headers
• Parameters and query strings
• Request and response schemas

Swagger ファイルは、開発者が API とどのようにやり取りするかを定義し、API ドキュメント、クライアントコード、サーバーコードの生成を支援することが多いです。

What Swagger versions and formats are supported by the OpenAPI connector?

OpenAPI コネクタは OpenAPI 3.0 仕様をサポートしています。YAML または JSON 形式で提供される API 定義を解析できます。Swagger ファイルは、この仕様に準拠している必要があり、そうでないと OpenAPI コネクタは正しく動作しません。

Can I use the OpenAPI connector to integrate third-party apps in Workato?

はい。OpenAPI コネクタは、Workato ワークフローへのサードパーティアプリケーションの統合を簡素化します。しかし、ユーザーエクスペリエンスは使用する Swagger ファイルの品質に依存します。OpenAPI コネクタは、カスタムコネクタを構築するための出発点として使用することもでき、認証や UI の変更などの要件に対して追加のカスタマイズが必要になる場合があります。

OpenAPI connector を使用して、Swagger ファイルで定義された OpenAPI 準拠の API を持つ任意のアプリケーションに接続できます。OpenAPI コネクタは Swagger ファイルを解析し、次の機能を含む Workato の動的 UI を生成します：

• Actions：API がサポートする機能（例えば：レコードの作成や更新）。
• Input/Output fields：各アクションのパラメータとレスポンスデータ。
• Objects：エンティティ（例えば：ユーザーや注文）を表す API オブジェクト。

How can I customize API operation grouping in the OpenAPI connector?

Workato におけるレシピアクションへの API 操作のグループ化方法をカスタマイズ することができます。OpenAPI コネクタは、Create record や Update record などの類似の操作をグループ化するために、キーワードと HTTP メソッド（例えば、POST、GET、PUT）を使用します。デフォルトのグループ化がニーズを満たさない場合は、次のオプションを使用してルールを変更します：

• Change keyword matches：操作名に基づいて特定のアクションに操作を割り当てます（例えば、createPet や addPet の両方を Create record にマッピングできます）。
• Use HTTP method semantics：GET、POST、PUT などの HTTP メソッドがアクションにどのようにグループ化されるかを定義します。

What triggers does the OpenAPI connector support in Workato?

OpenAPI コネクタは、リアルタイムの API イベントにワークフローが応答できるようにする 2 つの主要な トリガー をサポートしています：

• New/updated record：新しいオブジェクトが作成されるか既存のオブジェクトが更新されたときにトリガーされます。
• New/updated record (Batch)：オブジェクトのバッチが作成または更新されたときにトリガーされます。

これらのトリガーは、Swagger ファイルで指定された API 操作に直接マッピングでき、接続されたアプリケーションの変更に基づく自動ワークフローを可能にします。

What actions can the OpenAPI connector perform in Workato?

OpenAPI コネクタは、API の Swagger ファイルで定義された操作に対応するさまざまな アクション を実行できます。サポートされるアクションには次のものがあります：

• Create record：API で新しいオブジェクトを作成します。
• Update record：API で既存のオブジェクトを更新します。
• Delete record：API からオブジェクトを削除します。
• Search records：特定の条件に基づいて API からレコードのリストをクエリします。
• Get record details by ID：固有の識別子を使用して特定のオブジェクトの詳細情報を取得します。
• Custom action：事前定義されていないカテゴリーに適合しない独自の API 操作のためにカスタム HTTP リクエストを構築します。
• Execute operation：Swagger ファイルで定義されている API 操作を実行します。

コネクタは Swagger ファイルで定義された操作に基づいてこれらのアクションを生成するため、利用可能な機能は API 自体によって異なります。

What can I customize in the user interface generated by the OpenAPI connector?

Workato でのユーザーエクスペリエンスを向上させるために、OpenAPI コネクタが生成する UI を完全に カスタマイズ できます。利用可能なカスタマイズオプションは次のとおりです：

• Object and field names：用語を明確にして、よりユーザーフレンドリーにします。
• Field hints：説明やドキュメントへのリンクを追加します。
• API operation grouping：API アクションを論理的なグループに整理します。
• Unnecessary fields：エンドユーザーに関連しないフィールドを非表示にします。

インターフェイスをカスタマイズすることで、複雑な API でも Workato のワークフロー内でユーザーフレンドリーでアクセスしやすくなります。