

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 使用 OpenAPI 连接到服务
<a name="connectors-openapi"></a>

要使用 OpenAPI 将 App Studio 与服务连接起来，使构建者能够构建能够发送请求和接收来自服务的响应的应用程序，请执行以下步骤：

1. [获取 OpenAPI 规范文件并收集服务信息](#connectors-openapi-create-resources)

1. [创建 OpenAPI 连接器](#connectors-openapi-create-connector)

## 获取 OpenAPI 规范文件并收集服务信息
<a name="connectors-openapi-create-resources"></a>

要使用 OpenAPI 将服务连接到 App Studio，请执行以下步骤：

1. 转到你想要连接到 App Studio 的服务，然后找到 OpenAPI 规范 JSON 文件。
**注意**  
App Studio 支持符合 OpenAPI 规范版本 3.0.0 或更高版本的 OpenAPI 规范文件。

1. 收集配置 OpenAPI 连接器所需的数据，包括以下内容：
   + 用于连接到服务的基本 URL。
   + 身份验证凭证，例如令牌或用户名/密码。
   + 任何标题（如果适用）。
   + 任何查询参数（如果适用）。

## 创建 OpenAPI 连接器
<a name="connectors-openapi-create-connector"></a>

**为 OpenAPI 创建连接器**

1. 导航到 App Studio。

1. 在左侧导航栏的**管理**区域，选择**连接器**。您将进入一个页面，其中显示了现有连接器的列表，其中包含每个连接器的一些详细信息。

1. 选择 **\+ 创建连接器**。

1. 从**连接器类型列表中选择 OpenAPI** 连接器。现在，通过填写以下字段来配置您的连接器。

1. **名称：**输入 OpenAPI 连接器的名称。

1. **描述：**输入您的 OpenAPI 连接器的描述。

1. **基本 URL：**输入用于连接到服务的基本 URL。

1. **身份验证方法：**选择使用目标服务进行身份验证的方法。
   + **无：**无需身份验证即可访问目标服务。
   + **基本：**使用从所连接的服务中获取的**用户名**和**密码**访问目标服务。
   + **不记名令牌：**使用从服务的用户账户或 API 设置中获取的身份验证令牌的令牌**值**访问目标服务。
   + **OAuth 2.0：**使用 OAuth 2.0 协议访问目标服务，该协议授予 App Studio 访问服务和资源的权限，而无需共享任何凭据或身份。要使用 OAuth 2.0 身份验证方法，必须先从所连接的服务中创建一个代表 App Studio 的应用程序，以获取必要的信息。使用这些信息，填写以下字段：

     1. **客户凭证流程：**

        1. 在**客户端 ID** 中，输入目标服务的 ID。

        1. 在**客户端密钥**中，输入来自目标服务的密钥。

        1. 在**访问令牌 URL** 中，输入来自目标服务的令牌 URL。

        1. 或者，在**范围**中，输入应用程序的范围。范围是应用程序所需的权限或访问级别。请参阅目标服务的 API 文档以了解其范围，并仅配置您的 App Studio 应用程序所需的范围。

        在每次调用时添加要随服务发送的所有**变量**，然后选择**验证连接**以测试身份验证和连接。

     1. **授权码流程：**

        1. 在**客户端 ID** 中，输入目标服务的 ID。

        1. 在**客户端密钥**中，输入来自目标服务的密钥。

        1. 在**授权 URL** 中，输入来自目标服务的授权 URL。

        1. 在**访问令牌 URL** 中，输入来自目标服务的令牌 URL。

        1. 或者，在**范围**中，输入应用程序的范围。范围是应用程序所需的权限或访问级别。请参阅目标服务的 API 文档以了解其范围，并仅配置您的 App Studio 应用程序所需的范围。

1. **变量：**添加每次调用时要发送到服务的变量。配置期间添加的变量会被安全存储，并且只有在使用连接的应用程序的运行时才能访问。

1. **标头：**添加用于提供有关请求或响应的元数据的 HTTP 标头。您可以同时添加键和值，也可以仅提供生成器可以在应用程序中为其提供值的密钥。

1. **查询参数：**添加用于将选项、过滤器或数据作为请求网址的一部分传递的查询参数。与标题类似，您可以同时提供键和值，也可以仅提供生成器可以在应用程序中为其提供值的密钥。

1. **OpenAPI 规范文件：**通过拖放来上传 OpenAPI 规范 JSON 文件，或者**选择选择文件**来浏览本地文件系统并选择要上传的文件。

   添加后，文件即被处理并显示可用选项列表。为您的连接器选择必要的操作。

1. 选择**创建**。新创建的连接器将出现在**连接**器列表中。

现在，连接器已创建，构建者可以在他们的应用程序中使用它。