はじめに
Workato の API Platform には、APIレシピコレクションとAPIプロキシコレクションの2種類のコレクションタイプがあります。レシピベースの APIコレクションは RLCM（Recipe Lifecycle Management）や Environments 機能で環境移行できますが、APIプロキシコレクションの環境移行は公式にサポートされていません。
本記事では、OpenAPI仕様書を活用したAPIプロキシコレクションの環境間移行手順を紹介します。
APIプロキシコレクションのデプロイ事情
環境移行の違い
Workato には RLCM や Environments といった環境管理の仕組みがあり、レシピや依存関係（コネクション、ルックアップテーブルなど）を開発→テスト→本番と移行できます。
APIレシピコレクションは環境移行に対応しています。
一方、APIプロキシコレクションは公式ドキュメント上、環境移行の手順は記載されていません。
結論：手動での再構築が実質的に必要
現状では、APIプロキシコレクションを開発環境から本番環境へそのままデプロイする公式サポートされた方法が確認できないため、本番環境で新たにプロキシコレクションを作成する必要があります。
ただし、ゼロから手作業でやり直す必要はありません。
再構築が必要ですが、OpenAPI仕様書を活用すれば大部分を効率化できます
OpenAPI仕様書を使った移行手順
Step 1：開発環境からOpenAPI仕様書をダウンロード
- 開発環境の Workato にログイン
- Platform > API platform > API collections に移動
- 対象のAPIプロキシコレクションを選択
- コレクション概要ページの右上にある 「Download OpenAPI spec」 をクリック
- OpenAPI 3.0形式のファイルがダウンロードされる
この仕様書には、エンドポイントのパス、HTTPメソッド、リクエスト/レスポンスのスキーマなど、エンドポイント定義が含まれます。
Step 2：本番環境で新しいプロキシコレクションを作成
- 本番環境の Workato にログイン
- Platform > API platform > API collections > New collection を選択
- コレクションタイプとして API proxy collection を選択
- 転送先のHTTPコネクションを選択（または新規作成）
- 構成タイプの選択で 「Import OpenAPI specification」 を選択
- Step 1 でダウンロードした仕様書ファイルをアップロード
- Customize endpoints で必要なエンドポイントを選択
- コレクションを作成
OpenAPI仕様書をインポートすると、各エンドポイントのスキーマやヘッダー設定が自動的に構成されるため、手動でのスキーマ定義をスキップできます。
Step 3：本番環境で再設定が必要な項目
OpenAPI仕様書には含まれない情報があるため、以下の項目は本番環境で個別に設定する必要があります。
| 設定項目 | 説明 |
|---|---|
| HTTPコネクション | 本番環境用の認証情報で認証する。 |
| Collection path | 本番環境用のURLパスを設定する。 |
| クライアント設定 | 本番環境でクライアントを再作成する。 |
| アクセスポリシー | レート制限などのポリシーを再設定する。 |
注意点・Tips
Transformationは引き継がれない： 開発環境でリクエストやレスポンスの変換（Proxy Transformation）を設定していた場合、これらはOpenAPI仕様書には含まれません。本番環境のプロキシワークフロー上で再設定してください。
Base URLの違いに注意： 開発環境ではサンドボックスAPIを、本番環境では本番APIを指すように、HTTPコネクションのURLを適切に切り替えてください。
エンドポイントのテスト： プロキシエンドポイントは Activate 前でもテスト可能です。本番環境でインポートしたら、まず「Test request」タブで動作確認をしてから Activate することをおすすめします。
まとめ
WorkatoのAPIプロキシコレクションは、RLCM/Environments による環境間デプロイが明確にサポートされていないため、開発→本番の移行には手動での対応が必要です。ただし、OpenAPI仕様書のエクスポート→インポートを活用すれば、エンドポイント定義の大部分を効率的に移行できます。
クライアント設定、認証情報、Base URL など環境固有の設定は移行されないため、本番環境での再設定を忘れずに行いましょう。