OpenAPI FAQ ​

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

• エンドポイントメソッド（例：GET、POST）
• エンドポイントパス（例：/pet）
• ヘッダー
• パラメーターとクエリ文字列
• リクエストスキーマとレスポンススキーマ

Swaggerファイルは、開発者がAPIを操作する方法を定義し、多くの場合、APIドキュメント、クライアントコード、サーバーコードの生成に役立ちます。

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

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

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

• アクション：APIでサポートされる機能（例：レコードの作成または更新）。
• 入力/出力フィールド：各アクションのパラメーターとレスポンスデータ。
• オブジェクト：エンティティ（例：ユーザーまたは注文）を表すAPIオブジェクト。

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

• キーワード一致の変更：名前に基づいて操作を特定のアクションに割り当てます（例：createPetとaddPetはいずれもCreate recordにマッピングできます）。
• HTTPメソッドのセマンティクスの使用：GET、POST、PUTなどのHTTPメソッドをアクションにグループ化する方法を定義します。

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

• New/updated record：新しいオブジェクトが作成されたとき、または既存のオブジェクトが更新されたときにトリガーされます。
• 新規/更新レコード（バッチ）: オブジェクトのバッチが作成または更新されたときにトリガーします。

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

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

• Create record：API内に新しいオブジェクトを作成します。
• Update record：API内の既存のオブジェクトを更新します。
• Delete record：APIからオブジェクトを削除します。
• Search records：特定の条件に基づいて、APIにレコードのリストを問い合わせます。
• Get record details by ID：一意の識別子を使用して、特定のオブジェクトの詳細情報を取得します。
• カスタムアクション：事前定義されたカテゴリに当てはまらない一意のAPI操作向けに、カスタムHTTPリクエストを構築します。
• Execute operation：Swaggerファイルで定義されたAPI操作を実行します。

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

OpenAPIコネクターによって生成されるUIを完全にカスタマイズして、Workatoでのユーザーエクスペリエンスを向上できます。 次のカスタマイズオプションを利用できます：

• オブジェクト名とフィールド名：用語を明確にして、よりユーザーフレンドリーにします。
• フィールドヒント：説明またはドキュメントへのリンクを追加します。
• API操作のグループ化：APIアクションを論理的なグループに整理します。
• 不要なフィールド：エンドユーザーに関係のないフィールドを非表示にします。

インターフェイスをカスタマイズすることで、複雑なAPIでもWorkatoワークフロー内でユーザーフレンドリーかつアクセスしやすい状態を維持できます。