Template Editor とは何ですか?
Template Editor は、Templates の作成と変更を行うための Transloadit アカウントのインターフェースです。そのコードエディターでは、ファイル処理ワークフローを定義する宣言的な JSON である Assembly Instructions を記述します。
Template Editor の仕組み
Transloadit の Template Editor は、Assembly ワークフローを定義する Assembly Instructions の JSON を作成するための管理環境です。構文や利用可能な操作について支援を受けられますが、ステップ名、依存関係、パラメーターの型、出力の流れは、引き続き作成者が管理します。そのため、編集は設定作業であると同時に、API 経由で利用される本番環境の依存要素への変更でもあります。チームはワークフローの設計やトラブルシューティングにこのインターフェースを使い、変更版を呼び出し元に適用する前に、代表的なファイルで検証します。
要点
- 有効な JSON であることが証明するのは、ドキュメントを解析できることだけです。参照先が誤ったステップであったり、パラメーターが意味的に無効であったり、出力が呼び出し元の想定と異なったりする可能性は残ります。
- エディターを代表的なファイル一つだけで試すと、メディアに依存する分岐が実行されない場合があります。そのため、テストには受け付ける入力の各種別と、重要な失敗経路を含める必要があります。
- 同時編集や記録のない編集はロールバックを難しくする場合があります。レビュー済みの定義をエクスポートするか、同等のバージョン履歴をインターフェースの外部で管理すると、追跡可能性が向上します。
Template Editor が重要になる場面
エディターを使って、生成される JSON の妥当性を保ちながら、ワークフローのステップを確認・修正してください。構文上は正しい変更でも、ステップの依存関係や出力が変わる可能性があるため、本番環境で使う前に変更版をテストしてください。