管理您的规范

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息

Apigee Edge 可为您提供存储 OpenAPI 规范的场所。管理您的 OpenAPI 规范，如以下部分所述。

如需详细了解 OpenAPI 规范，请参阅什么是 OpenAPI 规范？

浏览规范列表

如需访问规范列表，请按以下步骤操作：

  1. 登录 apigee.com/edge。
  2. 选择一个组织。
  3. 在侧边导航菜单中，依次选择 Develop > Specs。

此时会显示当前的规范和文件夹列表。

规范列表

如上图所示，在规格列表中，您可以：

创建新的 OpenAPI 规范

要创建新的 OpenAPI 规范，请执行以下操作：

  1. 依次点击侧边导航栏中的 Develop > Specs。
  2. 点击 + 规范。
  3. 点击下拉菜单中的 New Spec。 系统会打开规范编辑器。
  4. 将示例规范替换为您自己的 OpenAPI 规范详细信息。
    请参阅使用规范编辑器创建规范。
  5. 点击保存以保存规范。
  6. 出现提示时，为该规范输入名称。
  7. 点击保存。

导入 OpenAPI 规范

要导入 OpenAPI 规范，请执行以下操作：

  1. 依次点击侧边导航栏中的 Develop > Specs。
  2. 点击 + 规范。
  3. 从下拉菜单中选择以下选项之一：
    • 导入网址：用于从网址导入规范。出现提示时指定名称和网址。
    • 导入文件以浏览本地目录以查看规范。
      系统会将该规范添加到列表中。
  4. 点击规范名称即可在规范编辑器中进行查看和修改。
    请参阅使用规范编辑器创建规范。

修改现有 OpenAPI 规范

要打开现有的 OpenAPI 规范，请执行以下操作：

  1. 依次点击侧边导航栏中的 Develop > Specs。
  2. 点击与规范列表中的规范相关联的行。
  3. 在规范编辑器中修改规范。
    请参阅使用规范编辑器创建规范。

根据规范列表中的规范创建 API 代理

借助 Apigee Edge，您可以根据自己设计并保存在规范编辑器中的 OpenAPI 规范来创建 API 代理。只需点击几下，Apigee Edge 中就会有一个 API 代理，其中包含自动生成的路径、参数、条件流和目标端点。然后，您可以添加 OAuth 安全机制、速率限制和缓存等功能。

在根据 OpenAPI 规范创建 API 代理后，如果规范发生修改，您需要手动修改 API 代理以反映实现的更改。请参阅如果我修改了规范，会出现什么情况？。

要根据规范列表中的 OpenAPI 规范创建 API 代理，请执行以下操作：

  1. 在侧边导航菜单中，依次选择 Develop > Specs。
  2. 根据需要，导航到包含 OpenAPI 规范的文件夹。
  3. 将光标放在要为其创建 API 代理的 OpenAPI 规范上，以显示操作菜单。
  4. 点击 生成代理。 系统会打开“创建代理”向导，并使用 OpenAPI 规范中的值预填充代理详情页面，如下图所示。
    构建代理向导
  5. 点击下一步。
  6. 按照根据 OpenAPI 规范创建 API 代理中的说明，逐步完成“创建代理”向导的剩余页面。（从第 8 步开始。）

重命名规范

要重命名规范，请执行以下操作：

  1. 在侧边导航菜单中，依次选择 Develop > Specs。
  2. 根据需要，转到包含相应规范的文件夹。
  3. 将光标放在要重命名的规范上，以显示操作菜单。
  4. 点击 重命名规范。
  5. 修改规范名称。
  6. 点击重命名以保存修改，或点击取消以取消修改。

将规范移至文件夹

您可以将规范整理到文件夹中，以方便管理和安全。如需将规范移动到文件夹中，请参阅使用文件夹整理规范。

删除规范

如果不再需要某个规范或该规范已失效，您可以从文件存储区中删除该规范。

要删除规范，请执行以下操作：

  1. 在侧边导航菜单中，依次选择 Develop > Specs。
  2. 将光标放在要删除的规范上，以显示操作菜单。
  3. 点击 “删除”图标。
  4. 点击删除，在提示框中确认删除操作。
  5. 删除不再需要的相关工件。