发布您的 API（原始版本）

<ph type="x-smartling-placeholder"></ph> 您正在查看 Apigee Edge 文档。
转到 Apigee X 文档。 信息

<ph type="x-smartling-placeholder">

如下文所述，将 API 发布到您的门户，以供应用开发者使用。

API 发布概览

向门户发布 API 的过程分为两个步骤：

  1. 选择要发布到门户的 API 产品。
  2. 根据 OpenAPI 规范的快照自动生成 API 参考文档，使应用开发者能够了解您的 API。（如需详细了解快照，请参阅什么是 OpenAPI 规范的快照？）

将 API 发布到门户时，系统会自动对您的门户进行以下更新：

  • 您的门户中会新增一个“API 参考文档”页面
    “API 参考”页面显示了从 OpenAPI 规范快照自动生成的 API 参考文档。开发者可以查看您的 API 文档，然后点击试用以发出 API 请求并查看输出。

    注意：您无法直接修改此页面的内容；它不会出现在您的门户页面列表中。

  • “API”页面中添加了指向“API 参考文档”页面的链接
    API 页面（包含在示例门户中）提供了发布到您的门户的所有 API 的列表，其中包含指向相应 API 参考文档的链接，以了解详情。

    注意：您无法直接修改此页面的内容；它不会出现在您的门户页面列表中。

什么是 OpenAPI 规范的快照？

每个 OpenAPI 规范都用作 API 整个生命周期内的可靠来源。API 生命周期的各个阶段（从开发、发布到监控）都使用相同的规范。修改规范时，您需要了解所做的更改在 API 的其他生命周期阶段对 API 产生的影响，如修改规范时会发生什么情况？中所述。

发布 API 时，您需要截取 OpenAPI 规范的快照，以生成 API 参考文档。该快照表示规范存储区中的特定规范版本。如果使用规范编辑器修改 OpenAPI 规范，您可能决定再截取该规范的快照，以反映 API 参考文档中的最新更改。

为 API 代理添加 CORS 支持

在发布 API 之前，您需要向 API 代理添加 CORS 支持，以支持客户端跨源请求。

CORS（跨源资源共享）是一种标准机制，允许在网页中执行的 JavaScript XMLHttpRequest (XHR) 调用与来自非源网域的资源进行交互。CORS 是通常针对所有浏览器强制执行的同源政策实现的解决方案。例如，如果您通过浏览器中执行的 JavaScript 代码对 Twitter API 进行 XHR 调用，调用将会失败。这是因为为浏览器提供页面的网域与为 Twitter API 提供的网域不同。CORS 通过允许服务器“选择启用”功能来解决此问题，如果希望提供跨源资源共享，则使用此属性。

如需了解如何在发布 API 之前为 API 代理添加 CORS 支持，请参阅向 API 代理添加 CORS 支持。

注意：大多数现代浏览器都会强制执行 CORS。请查看受支持浏览器的完整列表。如需 CORS 的深入说明，请参阅跨域资源共享 W3C 建议。

浏览 API 页面

如需访问 API 页面，请执行以下操作：

  1. 选择发布 > 门户，然后选择您的门户。
  2. 点击门户首页上的 API。

或者，您也可以在顶部导航栏的门户下拉菜单中选择 API。

系统会显示 API 列表。

API 参考文档

如上图突出显示，您可以通过 API 页面执行以下操作：

向门户添加 API

注意：您最多可以向门户添加 100 个 API。

如需向您的门户添加 API，请执行以下操作：

  1. 选择发布 > 门户，然后选择您的门户。
  2. 点击门户首页上的 API。
    或者，您也可以在顶部导航栏的门户下拉菜单中选择 API。
  3. 点击 + API。
    系统会显示“将 API 产品添加到门户”对话框。

  4. 在对话框的“API 产品”标签页上，选择要添加到门户的 API 产品。

  5. 点击下一步。

  6. 选择要用于快照的来源。
    如果您使用 OpenAPI 规范创建了 API 产品中包含的 API 代理，请从下拉列表中选择该规范。
    添加快照

    或者，您也可以选择：

    • 无规范，并在发布 API 后添加规范，如截取规范快照中所述。
    • 选择其他规范即可选择或上传新规范。

  7. 选中已发布复选框，将 API 发布到您的门户。如果您尚未准备好发布 API，请取消选中已发布。
    您以后可以按照在门户上发布或取消发布 API 中的说明更改设置。

  8. 在“受众群体”下，选择以下选项之一，以通过授予访问权限来管理 API 的受众群体：

    • 匿名用户：允许所有用户查看网页。
    • 已注册的用户：只允许注册用户查看该页面。

    您以后可以按照管理门户上的 API 的受众群体中的说明更改设置。

  9. 点击完成。

截取规范快照

发布 API 后，您可以随时截取 OpenAPI 规范的新快照，以更新在您的门户上发布的 API 参考文档。

截取 OpenAPI 规范的快照：

  1. 选择发布 > 门户，然后选择您的门户。
  2. 点击门户首页上的 API。
    或者，您也可以在顶部导航栏的门户下拉菜单中选择 API。
  3. 将光标置于您想为其截取快照的 API 上以显示相关操作。

  4. 点击 快照图标。

    注意：如果快照是最新的且已选择来源规范，系统会显示一条消息。

  5. 从“快照来源”下拉列表中选择现有规范，或者选择选择其他规范，然后选择或上传用于为 API 生成文档的新规范。或者，您也可以选择无规范，移除当前规范。

  6. 点击更新快照（如果您选择的是“无规范”，则点击移除快照）。

API 参考文档根据规范生成，并添加到“API 参考”页面。

在门户上发布或取消发布 API

如需在您的门户上发布或取消发布 API，请执行以下操作：

  1. 选择发布 > 门户，然后选择您的门户。
  2. 点击门户首页上的 API。
    或者，您也可以在顶部导航栏的门户下拉菜单中选择 API。
  3. 将光标置于要发布或取消发布的 API 上。
  4. 点击 “设置”图标。
  5. 选中启用复选框以在您的门户中发布 API。取消选中启用以取消发布 API。
  6. 点击保存。

在您的门户上管理 API 的受众群体

通过为以下对象授予对您的门户的访问权限，管理门户上的 API 受众：

  • 所有用户
  • 仅限注册用户

如需在您的门户上管理 API 的受众群体，请执行以下操作：

  1. 选择发布 > 门户，然后选择您的门户。
  2. 点击门户首页上的 API。
    或者，您也可以在顶部导航栏的门户下拉菜单中选择 API。
  3. 将光标悬停在要管理受众群体的 API 上，以显示相应操作。
  4. 点击 “设置”图标。
  5. 在“受众群体”下，选择以下选项之一： <ph type="x-smartling-placeholder">
      </ph>
    • 匿名用户：允许所有用户查看 API 产品。
    • 注册用户：仅允许已注册的用户查看 API 产品。
  6. 点击保存。

从门户中移除 API

如需从您的门户中移除 API，请执行以下操作：

  1. 选择发布 > 门户，然后选择您的门户。
  2. 点击门户首页上的 API。
    或者，您也可以在顶部导航栏的门户下拉菜单中选择 API。
  3. 将光标置于列表中的 API 上以显示操作菜单。
  4. 点击 删除。

排查已发布的 API 的问题

使用“试试看”时，如果系统返回 TypeError: Failed to fetch 错误，请考虑以下可能的原因和解决方法：

  • 对于混合内容错误，错误可能是由已知的 Swagger 界面问题引起。 一种可能的解决方法是确保在 OpenAPI 规范的 schemes 定义中在 HTTP 前面指定 HTTPS。例如：

     schemes:
   - https
   - http

  • 对于 CORS（跨源资源共享）限制错误，请确保您的 API 代理支持 CORS。 CORS 是一种支持客户端跨源请求的标准机制。请参阅为 API 代理添加 CORS 支持。同时确保在浏览器中启用 CORS。