API 定義テンプレートおよび製品定義テンプレートの作成と使用

API 定義および製品定義を作成する際は、テンプレート・ファイルを使用できます。テンプレート・ファイルは、形式が {{variable-name}} の変数を含む Handlebars テンプレートです。これらの変数は、API 定義または製品定義の作成時に値が置き換えられります。

1. 製品定義テンプレートまたは API 定義テンプレートは、最初から作成するか、API 定義と製品定義のテンプレートの例に記載されている例のいずれかをコピーして作成します。テンプレート・ファイルには、ファイル名拡張子 .hbs が必要で、API 定義と製品定義のテンプレート変数に記載されている Handlebars 変数のいずれかが含まれている場合があります。
2. 製品定義または API 定義をテンプレートから作成するには、以下のコマンドを入力します。

   apic create --type [api | product ] --template template_file --title product_title options

   template_file は使用する .hbs テンプレート・ファイルであり、product_title は作成する製品のタイトルであり、options はコマンド・ラインの任意の追加オプションです。テンプレート・ファイルのパスは、絶対パス、またはコマンドを実行する場所と相対するようにできます。あるいは、template-path 構成変数を、テンプレートが格納されているディレクトリーの場所に設定できます。

   製品定義または API 定義を作成するときに、コマンド・ラインの各オプションの値を Handlebars テンプレートの対応する変数で置き換えます。例えば、必須の --title オプションの値をテンプレート・ファイルの info.title フィールドの値で置き換えます。コマンドは、--name オプションで指定された名前を使用して製品定義の YAML ファイルを作成します。--name オプションを指定しなかった場合は、指定されたタイトルを小文字に変換してスペースをダッシュで置き換える方法で製品の YAML ファイルの名前が生成されます。

   --template オプションの他に、以下の構成変数を使用して、テンプレートで処理する際のデフォルト値を設定できます。

   • template-default-product - 製品テンプレート .hbs ファイルの基本ファイル名。
   • template-default-api - API テンプレート .hbs ファイルの基本ファイル名。
   • template-path - テンプレートを検索するディレクトリーのリスト。1 つ以上のディレクトリーを指定できます (絶対パス)。複数ディレクトリーは、空白で区切り、引用符で囲みます。この構成変数は、--template オプションとともに使用できます。

   すべての構成変数と同様、これらの値はローカルに (単一のアプリケーション・プロジェクトに対して) またはグローバルに (すべてのプロジェクトに対して) に構成できます。詳しくは、Toolkit コマンドの要約を参照してください。