---
title: API 试用！
slug: docs/cn/api
description: 了解如何使用“试用！”功能在您的网页浏览器中便捷地测试 API。探索所需步骤，包括导入 API 文件、配置默认值以及定义测试参数。了解如何查看您的请求代码片段 requ
createdAt: 2023-04-26T07:38:48.000Z
---

:::hint{type="info"}
“**试试吧！**” 功能允许您直接在浏览器中测试您的 API。它可在已发布的文档门户或编辑器中直接使用。
:::

## 如何配置

“**试一试！**” 功能使用 [fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch)，因此为了使其正常工作，您的 API 引用需要包含以下内容：

- 指向 API 的绝对路径 URL（而不仅仅是路径）
  - 在 .yml 文件中添加如下 URL
- servers:
  - url 示例：https\://petstore3.swagger.io/api/v3（您的实际 URL）
- 授权方法将从您的 API 文件中读取，并包含在每个 API 页面中
- 为文档域启用或禁用 CORS，以便用户能够实际测试您的 API

## 工作原理

::::WorkflowBlock
:::WorkflowBlockItem
导入您的 API 文件（[直接导入](docId\:a-NbWp43yWULjY3FOEReP) 或 [github 同步](docId\:jKxSM2OUEQN7lmZFOCVqo)）
:::

:::WorkflowBlockItem
【可选】在您的 OpenAPI 文件中定义 [“default”](docId\:a-NbWp43yWULjY3FOEReP) 值。这样，当您导入 API 时，所有“default”值都会添加到代码示例中，您可以立即测试 API，而无需手动向参数添加值。
:::

:::WorkflowBlockItem
使用测试参数配置 API 方法

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/wnjtlYGiV-WHIota1T9da_tryit-light.png)
:::

:::WorkflowBlockItem
更新参数后，右侧（或根据您的视图设置显示在下方）的代码示例也会随之更新为您添加的测试参数，从而提供包含多种语言的请求代码片段

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/WaqQRkD0Pzl7vY4HXPjWS_matching-items-light.png)
:::

:::WorkflowBlockItem
点击 **试一试！** 按钮，并查看示例代码下方的响应区域

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/h3z_pRa5GGHM4S2OFI7nf_response-light.png)
:::
::::