# 使用示例

在整个 API 的示例字段中添加样本数据。

在 API 契约中，您可以为 API 的各种元素添加示例值。一旦定义了示例，在向您的 Mock 发起 API 调用时就会使用该示例。

在以下示例中，使用示例创建了一个数据类型。

![从 JSON 示例生成的 Character 数据类型的屏幕截图。](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Resources/Images/ApiDesigner/shows_a_example_used_in_a_data_type.png)

然后，该数据类型用作操作的响应正文。

![名为 Get a Star Wars character by ID 的方法会返回 Character 数据类型。](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Resources/Images/ApiDesigner/shows_a_data_type_used_in_an_operation_response.png)

您可以在 API 的不同部分定义示例，在向您的 Mock 发起调用时，某些示例可能会覆盖其他示例。此处使用了数据类型的示例，但您也可以为操作的响应定义示例。

![已为响应定义了一个新示例。这里的角色是莱娅·奥加纳。](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Resources/Images/ApiDesigner/shows_an_operation_response_using_a_data_type_and_an_added_example.png)

不支持外部示例。