创建编码定义

编码定义用于定义特定模式属性与其编码信息之间的映射。

准备工作

配置内容定义时启动编码定义创建窗口; 请参阅 编辑内容定义。

关于此任务

注：
  • 此任务与配置 OpenAPI 3.0 API 定义相关。 有关如何配置 OpenAPI 2.0 API 定义的详细信息，请参阅 编辑 OpenAPI 2.0 API 定义。
  • OpenAPI 3.0 API 仅支持 DataPower® API Gateway，而不支持 DataPower Gateway (v5 compatible)。
  • 有关当前 OpenAPI 3.0 支持限制的详细信息，请参阅 IBM® API Connect 中的 OpenAPI 3.0 支持。

您可以使用 API Designer UI 应用程序或使用基于浏览器的 API Manager UI 来完成此任务。

您可以随时通过单击 源 图标 OpenAPI 源图标直接切换到底层 OpenAPI YAML 源。 要返回到设计表单，请单击 表单 图标 表单图标。

过程

  1. 提供以下信息：
    • 名称: 模式属性的名称。
    • 内容类型：用于编码属性的 Content-Type；例如，application/xml; charset=utf-8，以及 image/png, image/jpeg。
    • 样式：描述属性值的序列化方式，具体取决于属性值的类型。 选择下列其中一个选项：
      • form: 由 RFC6570定义的表单样式属性。
      • spaceDelimited：用空格分隔的数组值。
      • pipeDelimited：用竖线分隔的数组值。
      • deepObject：提供一种使用表单属性来呈现嵌套对象的简单方法。
    • 分解：如果选中此项，那么类型为 array 或 object 的属性值会为映射的数组或键/值对的每个值生成单独的属性。
    • 允许保留: 确定属性值是否应允许包含保留字符 (由 RFC3986 (:/?#[]@!$&'()*+,;=) 定义) 而不使用百分比编码。
  2. 单击 创建。
    将显示编码定义详细信息以进行进一步编辑; 请参阅 编辑编码定义。