创建内容定义

内容定义描述 API 请求、响应或参数的内容。 您可以在 API 定义中的各种位置创建内容定义。

准备工作

启动内容定义创建窗口。 有关 API 定义中可创建内容定义的区域的详细信息,请参阅以下主题:

关于此任务

注:
  • 此任务与配置 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. 提供以下信息:
    • 内容类型: 选择内容类型; 例如, application/json
      注: 当编辑器中的 内容类型 字段提供媒体类型的选择列表时,通过直接编辑 API 的 OpenAPI 源,可以指定 媒体类型范围; 例如, text/**/json*/*。 对于匹配多种类型的请求或响应,只有最具体的类型适用。 例如,text/plain 覆盖 text/*
  2. 单击 创建
    将显示内容定义详细信息以进行进一步编辑; 请参阅 编辑内容定义