创建和使用自定义 StyleBook
您可以为您的部署编写自己的 StyleBook，将其导入 NetScaler Console，并创建配置对象。您还可以使用 API 从您的 StyleBook 创建配置。
本文档包含以下信息：
开始之前
在开始创建 StyleBook 之前，请确保您了解以下内容：
-
NITRO API。有关更多信息，请参阅 Nitro API 文档
-
YAML
StyleBook 文件使用 YAML 格式。有关 YAML 格式的信息，请参阅 YAML 语法。
以下是创建 StyleBook 时必须注意的 YAML 准则列表：
-
YAML 区分大小写。
-
YAML 需要正确的缩进
-
使用
<spacebar>键创建正确的缩进。请勿使用<tab>键。在将 StyleBook 导入 MA 服务时，使用<tab>键会导致编译错误。 -
请勿在引号内使用字符串。仅当字符串包含标点符号（破折号、冒号等）时，才将字符串包含在引号内。如果您想将数字解释为字符串，请将数字包含在引号内，或使用 StyleBook 的 str() 内置函数。
-
诸如 YES/Yes/yes/Y/y/NO/no/No/n/N、ON/On/on/OFF/Off/off 和 TRUE/true/truthy/FALSE/False/false/falsely 等字面量被视为布尔值，分别等同于 true 和 false。要将它们解释为字符串，请将它们包含在引号内。例如：
-
"YES"
-
"否"
-
"真"
-
"假"等。
-
注意
在将您的 StyleBook 文件导入 NetScaler Console 之前，建议您验证文件是否符合 YAML 格式。我们建议您使用 StyleBooks 中内置的 YAML 验证器来验证和导入 YAML 内容。
配置 StyleBooks 时，您只能使用支持 创建 和 删除 操作（POST 和 DELETE HTTP 方法）的 Nitro 配置资源。有关更多信息，请参阅 Nitro API 文档。
StyleBook 的结构
编写 StyleBooks 需要您了解 StyleBooks 的语法、句法和结构。典型的 StyleBook 包含以下部分：
-
标头：此部分允许您定义 StyleBook 的标识并描述其功能。这是必填部分。
-
导入 StyleBooks：此部分允许您声明要从当前 StyleBook 引用哪些其他 StyleBook。编写 StyleBook 需要导入 NetScaler NITRO 配置 StyleBooks 或其他 StyleBooks。这是必填部分。
-
参数：此部分允许您定义 StyleBook 中创建配置所需的参数。它描述了 StyleBook 接受的输入。这是可选部分。
-
组件：此部分允许您定义 StyleBook 为特定配置创建的实体（配置对象）。此部分被视为 StyleBook 的核心。组件通常使用参数部分中提供的输入来调整 StyleBook 生成的配置。这是可选部分。StyleBook 可以包含参数部分、组件部分或两者兼有。仅包含参数部分的 StyleBook 可用于定义可供其他 StyleBooks 使用的参数列表。这促进了参数组在 StyleBooks 集合中的可重用性。仅包含组件部分的 StyleBook 可用于在 StyleBook 中指定属性值，而不是定义参数来获取用户输入。
-
输出：参数部分定义了 StyleBook 的输入，而此可选部分定义了其输出。在此可选输出部分中，您可以指定要向从该 StyleBook 创建配置的用户以及导入该 StyleBook 的其他 StyleBooks 公开的组件。用户和导入的 StyleBooks 随后可以引用公开组件的属性。
-
操作：StyleBook 可以包含一个可选部分，用于在 NetScaler Console 中对作为 StyleBook 一部分的任何虚拟服务器启用分析。
下图显示了 StyleBook 的简单大纲。
以下示例可帮助您了解 StyleBook 的语法和结构，以及如何编写复杂程度不断提高的 StyleBook。