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

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

開始前に

このトピックで説明されているステップを実行するには、 IBM® API Connect デベロッパーズ・ツールキットをインストールしておく必要があります。詳細は、「 API Connect ツールキットの設定」を参照してください。

手順

製品またはAPI定義テンプレートをゼロから作成するか、 APIおよび製品定義テンプレート例で提供されている例のいずれかをコピーして作成します。テンプレートファイルのファイル名拡張子は .hbs でなければなりません。また、 APIおよび製品定義用のテンプレート変数で説明されているハンドルバー変数のいずれも含めることができます。
製品定義または API 定義をテンプレートから作成するには、以下のコマンドを入力します。
```
apic create:[api | product] --template template_file --title [api_title | product_title] options
```
ここで、 template_file は使用するテンプレート .hbs ファイル、 api_title または product_title は作成する API または製品のタイトル、 options は任意の追加のコマンド行オプションです。テンプレート・ファイルのパスは、絶対パス、またはコマンドを実行する場所と相対するようにできます。

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