跳到主要内容

View API Settings

要查看 API 设置，请导航到 Backend Servers 页面。找到您需要的 API。点击 API 以打开详细摘要。

提示

使用搜索和过滤工具快速找到您需要的 API。

概述​

概述选项卡提供有关所选 API 的关键信息，包括其配置和元数据。

API 信息​

本节包含识别和描述 API 的一般性、高层次信息。

  • Version: 指示 API 的特定发布版本，遵循语义版本控制（例如，v1.0.0）。这有助于跟踪随时间的更新和变化。
  • Backend System Name: 系统内 API 的唯一内部标识符或代号（例如，petstorev3）。
  • Description: 详细叙述 API 的目的、其所基于的规范（如 OpenAPI 3.0）、设计方法及其目标。
  • Label: 用于对 API 进行分类、过滤和组织的键值对。它们提供了一种灵活的方式来添加自定义元数据。一个 API 可以有多个标签用于不同的目的。

后端信息​

本节详细说明与 API 交互所需的技术端点信息。

  • Backend ID: 一个唯一的、系统生成的字母数字字符串，用于标识支持 API 的特定后端服务（例如，68a67d3008c05608c7f1c734）。
  • Domain: API 托管的主要网页地址。这是所有 API 调用的基础 URL（例如，https://petstore3.swagger.io/api/v3）。
  • BasePath: 附加到域名的路径段，以创建 API 端点的完整基础 URL。值为 / 表示端点直接从域根访问。

认证信息​

本节指定访问 API 的安全要求。

  • Authentication Type: 定义用于保护 API 的方法。例如，值为 None，这意味着 API 是公开的，不需要任何凭据或令牌进行访问。

元信息​

本节提供有关 API 在系统中生命周期的审计和跟踪信息。

  • Date of Creation: API 最初在系统中注册的确切日期和时间。
  • Constructor: 创建 API 的个人或过程的用户名或 ID。
  • Date of Modification: 指示 API 配置最后一次更新的时间戳。
  • Modifier: 最近进行更改的个人或过程的用户名或 ID。

API 预览​

API 预览选项卡提供了一个交互式用户界面，通常由 Swagger UI 等工具提供支持，允许您直接从浏览器探索和测试 API 的端点。

API 规范​

在本节中，您可以找到 API 规范的主要识别详细信息。

  • API Title: API 的官方名称。
  • Version Badges: 小标签，指示 API 的版本号（例如，1.0.27）和它遵循的规范（例如，OAS 3.1，即 OpenAPI 规范 3.0）。
  • Description: API 的人类可读摘要。

API 认证​

在本节中，您可以找到允许您配置和验证测试请求的元素。

  • Servers: 一个下拉菜单，用于选择 API 调用的目标服务器环境。这允许您在不同的基础 URL 之间切换，例如开发、预发布或生产环境。
  • Authorize: 一个按钮，打开对话框“可用授权”，您可以在其中输入您的身份验证凭据，如 API 密钥或 OAuth2 令牌。一旦设置，这些凭据将自动包含在您从此页面发出的任何测试请求中。

API 端点​

这是 API 预览的核心，列出了所有可用的操作。

  • Endpoint Groups: 端点根据“标签”组织成逻辑组，通常对应于特定资源。在此示例中，所有端点都归类在宠物标签下。
  • Endpoint Details: 每一行代表您可以执行的单个操作，并包括：
    • HTTP Method: 操作类型，例如 PUT（更新）、POST（创建）或 GET（读取）。
    • Path: 端点的特定 URL 路径（例如，/pet，/pet/findByStatus）。
  • Description: 该端点的功能简要概述。
    • Authentication Indicator: 锁定图标指示端点是否需要身份验证。解锁图标表示它是开放的，而锁定图标表示您必须使用“授权”按钮提供凭据。

通过点击任何端点行，您可以展开以查看详细信息，包括所需参数、请求体结构和可能的响应，甚至执行实时 API 调用：

Schemas​

位于预览页面底部，Schemas 部分定义了 API 请求和响应中使用的所有数据模型的结构。

  • Schema List: 此区域列出了所有定义的数据对象，例如 Pet, Order, 和 User。
  • View Details: 您可以点击任何模式名称以展开。这将显示对象属性的详细视图，包括字段名称（例如 id, name）、它们的数据类型（integer, string）和示例。