创建示例

您可以向 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 源。要返回设计表单，请单击表单图标表单图标。

过程

创建示例；您可以从头开始创建示例，也可以引用示例组件中定义的示例。
- 要从头开始创建示例，请在定义选项卡上提供以下信息：
  - 示例名称：如果要创建示例组件，那么此名称定义一个键，该键支持在 API 定义中的其他位置引用此示例；该引用具有以下格式：
```
#/components/examples/Name
```
  - 摘要：示例的摘要描述。
  - 描述: 示例的完整描述。您可以使用 CommonMark 语法来表示丰富的文本。
  - 外部值：指向文字示例的 URL。这能够引用无法轻松包含在 JSON 或 YAML 文档中的示例。例如，这可能是 PDF。
- 要引用在示例组件中定义的示例，请在引用选项卡上提供以下信息：
  - 示例名称：如果要创建示例组件，那么此名称定义一个键，该键支持在 API 定义中的其他位置引用此示例；该引用具有以下格式：
```
#/components/examples/Name
```
  - 引用来源：选择对示例组件的引用。
单击创建。
显示示例详细信息，以便进一步编辑；请参阅编辑示例。