编辑请求主体

请求主体定义了 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. 提供以下信息：
    • 名称: 请求主体的名称。
      创建请求主体组件时可用，此名称定义一个键，通过该键即可在 API 定义中的其他位置引用此请求主体；引用格式如下：
      #/components/requestBodies/Name
    • 描述: 请求主体的描述。 您可以使用 CommonMark 语法进行富文本表示。
    • 内容：内容定义描述请求主体的内容。

      要为请求正文定义新的内容定义，请单击添加 ，然后参考创建内容定义。

      要编辑现有内容定义，请单击内容定义名称，然后参阅编辑内容定义。

    • 必需：确定请求中是否需要请求主体。
  2. 完成后单击 保存 。

后续操作

如果需要，请使用面包屑跟踪以浏览至所处理对象的层次结构中的其他位置。