管理您的规范

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。 信息

Apigee Edge 为您提供了存储 OpenAPI 规范的位置。按照以下部分中的说明管理您的 OpenAPI 规范。

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

浏览规范列表

如需访问规范列表，请执行以下操作：

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

系统会显示当前的规范和文件夹列表。

如上图所示，您可以在规范列表中执行以下操作：

• 创建和import规范
• 使用多步向导根据规范生成 API 代理
• 使用文件夹整理规范，并浏览这些文件夹（请参阅使用文件夹整理内容）
• 点击某个行可修改规范或打开文件夹
• 重命名或删除规范
• 搜索规范和文件夹列表

创建新的 OpenAPI 规范

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

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

导入 OpenAPI 规范

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

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

修改现有 OpenAPI 规范

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

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

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

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

通过 OpenAPI 规范创建 API 代理后，如果该规范被修改，您需要手动修改 API 代理，以反映所实现的更改。请参阅如果修改规范会发生什么情况？。

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

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

重命名规范

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

1. 在侧边导航菜单中依次选择开发 > 规范。
2. 如有需要，请前往包含规范的文件夹。
3. 将光标置于要重命名的规范上方，以显示操作菜单。
4. 点击 。
5. 修改规范名称。
6. 点击重命名以保存所做修改，或点击取消以取消。

将规范移至文件夹

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

删除规范

当规范不再需要或失效时，您可以从文件存储区中将其删除。

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

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