---
title: 导入 OpenAPI / Swagger
slug: docs/cn/openapi-swagger
description: 了解如何在 Archbee 中利用 OpenAPI 导入功能来创建面向开发者的产品文档。探索其优势、支持的版本、身份验证方法、默认参数的预填充以及示例值的展示。本指南提供全面说明。
createdAt: 2021-10-29T07:42:12.000Z
---

## 为什么使用 OpenAPI 导入？

如果您的产品是为开发人员构建的，或者您的产品具有 API，那么您需要优秀的产品文档——否则，您将无法真正触达开发人员。

一旦您导入 OpenAPI 文件，Archbee 将读取并将其转换为精美的 UI，并准备好用于：

- **公开共享 **（在自定义域名上）
- **内部共享**，与您的同事和团队一起使用

导入后，您可以同步、更新并测试您的 OpenAPI。更多详情请参见下方章节。

## 规则和默认设置

:::hint{type="info"}
导入的 OpenAPI 文件无法在 Archbee 中手动修改。

要更新和维护您的 OpenAPI，请查看我们的[同步选项](docId\:uDtb7II_Y9uW0lUA3l-_g)
:::

### 支持的 OpenAPI 版本：

Archbee 当前支持以下 OpenAPI 版本导入：

1. 版本 2.0 和 2.0.XX
2. 版本 3.0 和 3.0.XX
3. 版本 3.1 和 3.1.XX

### 支持的 Auth 方法

Archbee 当前支持以下 Auth 方法：

1. [Basic Authentication](https://swagger.io/docs/specification/authentication/basic-authentication/)
2. [API Keys](https://swagger.io/docs/specification/authentication/api-keys/)
3. [Bearer Authentication](https://swagger.io/docs/specification/authentication/bearer-authentication/)

如果您导入的 OpenAPI 文件使用其他 Auth 方法，它们仍会被正确导入，但 Auth 方法将被忽略。

这意味着您仍将获得完整的 Archbee OpenAPI 体验，**除了**当您的 endpoint 需要上方列表之外的 Auth 方法时，将无法使用 Try It! 功能。

### 其他

1. 如果您在 OpenAPI 中定义了“**默认**”参数并为其提供了值，代码示例和参数框将自动预填充该值。

   这使您的用户或客户能够轻松测试 API，使用[试一试！](docId\:rq4omdsF1TLiW0Lc2KWZ5)而无需更新所有必填参数。

2. 如果您在 OpenAPI 中定义了“**示例**”参数，则示例值将显示在左侧、API 参数下方。

   这可帮助用户识别该参数所需的输入类型。

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

## 它是如何工作的？

::::WorkflowBlock
:::WorkflowBlockItem
使用 **导入内容** 导入您的 OpenAPI 文件：

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

或者在每个 space 中使用 **导入** 选项：

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

或者直接从您的 [GitHub](docId\:jKxSM2OUEQN7lmZFOCVqo) 仓库同步您的 OpenAPI 文件。

借助 Archbee 的 [Github 集成](docId\:jKxSM2OUEQN7lmZFOCVqo) 您可以直接从您的仓库添加并同步 OpenAPI 文件。
:::

:::WorkflowBlockItem
预览并 [测试](docId\:rq4omdsF1TLiW0Lc2KWZ5) 您导入的 OpenAPI

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

使用 Archbee 的 [API 试一试！](docId\:rq4omdsF1TLiW0Lc2KWZ5) 功能预览并测试您新导入的 OpenAPI。
:::

:::WorkflowBlockItem
**发布** 或 **分享它** 给您的同事或客户！

将其发布到 Preview 或自定义域名，使其可供您的同事、团队或用户访问。

如果您希望保护内容并仅分享给特定对象，请查看我们针对已发布门户的 [公共访问控制](docId\:mlpe5kbw014Xm_x0bWknb) 选项。
:::

:::WorkflowBlockItem
维护、同步并进行配置：

1. [手动同步](docId\:uDtb7II_Y9uW0lUA3l-_g)
2. [通过API自动同步](docId\:uDtb7II_Y9uW0lUA3l-_g)
3. [更改示例代码语言](docId\:uDtb7II_Y9uW0lUA3l-_g)
:::
::::

## 以下是其工作方式的视频演示

::embed[]{url="https://youtu.be/LQ3nEGCcdKg"}