第 6 步:发布 API

本页面适用于 ApigeeApigee Hybrid

查看 Apigee Edge 文档。

在此步骤中,您将通过执行以下步骤,将 API 发布到门户:

  1. 根据规范创建 API 代理
  2. 创建 API 产品
  3. 将 API 发布到您的门户

第 1 步:根据规范创建 API 代理

根据描述 API 的 OpenAPI 规范创建 API 代理。

如需根据 OpenAPI 规范创建 API 代理,请执行以下操作:

  1. 在 Cloud 控制台中的 Apigee 中,依次前往代理开发 > API 代理页面。

    前往 API 代理

  2. 点击创建。系统会打开创建代理向导,提示您选择要创建的 API 代理的类型。

  3. 点击代理模板框。

  4. 点击 OpenAPI 规范模板,反向代理(最常见)

  5. 在浏览器中打开以下文件,然后保存该文件:

    https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml

  6. 第 1 步:OpenAPI 规范中,点击浏览

  7. 找到您刚下载的 OpenAPI 规范文件,选择该文件,然后点击打开

  8. 点击下一步

  9. 第 2 步:代理详情中,系统会使用 OpenAPI 规范中的值预填充字段。按照以下说明修改说明字段:适用于 Hello World 的 API 代理

  10. 点击下一步

  11. 第 3 步:流中,选择所有操作。

  12. 点击下一步

  13. 第 4 步:部署中,选择要部署到的环境。

  14. 点击确定

  15. 点击创建

部署代理后,部署部分中的状态列会显示一个绿色图标,表明已部署 API 代理修订版本。您可以将指针悬停在状态图标上,查看有关部署的更多信息。

第 2 步:创建 API 产品

创建一个 API 产品,其中包含您要向 API 使用方公开的 API 资源。

如需创建 API 产品,请执行以下操作:

  1. 在 Cloud 控制台的 Apigee 中,依次前往分发 > API 产品页面。

    前往 API 产品

  2. 点击创建。系统会显示产品详情页面。输入 API 产品的产品详情

    字段
    名称 Hello World
    显示名称 Hello World
    说明 简单的 hello world 示例
    环境 选择在其中部署 API 代理的环境。
    访问 公开
    自动批准访问请求 已启用
    Quota (留空)
    允许的 OAuth 范围 (留空)

  3. 操作部分中,点击添加操作以标识要添加到 API 产品的操作。

    • 来源下,选择 API 代理,然后从下拉列表中选择 Mock-Target-API
    • 操作 (Operation) 下的路径 (Path) 字段中输入正斜杠 (/)。 忽略其他字段。
  4. 点击保存以保存该操作。

  5. 点击保存以保存该产品。

第 3 步:将 API 发布到您的门户

将 API 发布到您的门户,以便您的客户了解并使用 API。

如需将 API 发布到您的门户,请执行以下操作:

  1. 在 Cloud 控制台的 Apigee 中,前往分发 > 门户页面。

    前往“门户”

  2. 点击我的第一个门户 (My first portal) 行以打开该门户。

  3. 点击 API 标签页。

  4. 点击添加 API

  5. API 产品部分,选择 Hello World

  6. 选择已发布(在目录中列出) (Published (listed in the catalog)) 以将 API 发布到您的门户。

  7. 显示标题部分,输入 Hello World

  8. 显示图片部分,点击选择

  9. 点击素材资源

  10. 点击 home-background.jpg 对应的预览

  11. 点击选择

  12. API 文档部分,如需通过 OpenAPI 规范的快照自动生成 API 参考文档,请执行以下操作:

    1. 选择 OpenAPI 文档 (OpenAPI document)。
    2. 点击选择
    3. 点击网址标签页。
    4. 规范名称字段中输入 helloworld
    5. 将以下网址复制并粘贴到网址字段中:
      https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
    6. 点击选择
  13. 点击保存

第 4 步:查看 API 参考文档

如需查看 API 参考文档,请执行以下操作:

  1. 在 Apigee 界面中,点击实时门户以查看实时门户中的更改(如果实时门户已在另一个标签页中打开,请进行刷新)。
  2. 在实时门户中,请执行以下操作:
    1. 在顶部导航栏中点击 API 以查看已发布的 API。
    2. 点击 Hello World 卡片以查看 API 参考文档。
    3. 试用您的 API!

通过“试用此 API”面板发布的 Mock Target API