YAML 構成での変数の割り当て

CLI ツールを使用して、YAML 構成ファイル内に変数を定義できます。 これらの変数は、ツールのさまざまな側面を構成するために使用されます。

YAML ファイルは、以下の 3 つの方法で構成できます。
  • 同じ YAML ファイルを使用します。
  • 環境変数の使用
  • 外部構成 YAML ファイルを使用します。
注: 変数は、二重中括弧で囲む必要があります。 例えば、 "{{configs.base_url}}" または "{{paths.basePath}}"などです。 これらのプレースホルダー ( "{{...}}"の形式) は、優先順位階層に応じて、ソース YAML ファイル、環境変数、または外部構成ファイルからの対応する値に置き換えられます。

変数割り当ての優先順位階層は、以下のとおりです。

  1. 外部構成 YAML ファイル (最高の優先順位)
  2. 環境変数
  3. 同じ YAML ファイルに設定された構成 (最低優先順位)
3 つの方法をすべて使用して YAML ファイルを構成する場合、外部構成 YAML ファイルを使用して割り当てられた変数が優先されます。

1. 同じ YAML ファイルに設定された構成

同じ YAML ファイル内から変数に値を割り当てることができます。 このためには、以下の方法で YAML ファイルを構成する必要があります。

 configs:
    basePath: ...paths:
        - basePath: ...

ここでは、 configs キーを使用して、 basePath や pathsなどの変数を定義します。 これらの変数は、YAML ファイル全体でツールを構成するために使用できます。

2. 環境変数

環境変数を使用して、YAML ファイルで構成されている変数の値をオーバーライドできます。 環境変数が YAML ファイルに定義されている変数と同じ名前を共有する場合、YAML 変数の値は対応する環境変数に置き換えられます。 これにより、外部で構成をカスタマイズすることができます。

例えば、 base_url という名前の変数が YAML ファイルで "{{configs.base_url}}"として定義されていて、その値が base_urlという名前の環境変数に置き換えられたとします。 YAML ファイル内の base_url の値は、 base_url 環境変数の値によってオーバーライドされます。

3. 外部構成 YAML ファイル

CLI ツールは、外部構成ファイルを使用して、最高レベルの構成優先順位をサポートします。 外部構成ファイルを使用するには、CLI ツールの実行時に --config-file または -c フラグを使用してそのファイル・パスを指定する必要があります。 外部構成ファイルで定義された変数は、メインの YAML ファイル内で定義された変数、または環境変数によって定義された変数に優先します。

例えば、以下の内容を持つ config.yaml という名前の外部構成ファイルがあるとします。

 external_config:
    base_url: https://example.comapi_key: your-api-key

--config-file=config.yaml フラグを指定して CLI ツールを実行すると、config.yaml ファイルで定義された変数によって、メインの YAML ファイルまたは環境変数内の対応する変数が置き換えられます。

テストを YAML ファイルとして定義する方法について詳しくは、 テスト定義の構文を参照してください。