发布概览

您正在查看 Apigee X 文档。
查看 Apigee Edge 文档。

发布是将 API 提供给应用开发者使用的过程。

视频:下面的视频简要介绍了 API 发布。

发布 API 涉及以下任务,如以下主题所述:

  1. 创建与您的 API 捆绑的 API 产品。
  2. 注册应用开发者
  3. 注册开发者应用。
  4. 为您的 API 提供文档和社区支持。

任务 1:创建 API 产品

发布的第一个任务是创建 API 产品。API 产品是一组 API 资源,作为软件包提供给应用开发者使用。使用 Apigee API 或界面创建 API 产品。(如需详细了解 API 产品,请参阅什么是 API 产品?。)

显示开发者、应用、API 和后端服务的从左到右的序列图。突出显示 API 图标和资源。虚线从开发者指向开发者已构建的应用的图标。从应用出发的箭头和指向应用的箭头表示到 API 图标的请求和响应流,请求上方显示应用密钥。突出显示 API 图标和资源。API 图标下是两组资源路径,分为两个 API 产品:位置产品和媒体产品。位置产品具有 /countries、/cities、/languages 资源,媒体产品具有 /books、/magazines、/movies 资源。API 的右侧是 API 调用的后端资源,包括数据库、企业服务总线、应用服务器和通用后端。

在此图中,API 包含两个产品,每个产品都包含三个 API 资源。

作为 API 提供方,您负责构建 API 和 API 产品,以处理访问权限控制、使用限制以及任何其他业务要求。例如,您可以:

  • 发布允许对 API 资源具有只读权限的免费 API 产品。
  • 以较低的价格发布第二个 API 产品,具有与免费版本相同的 API 资源的读写权限,但具有低访问限制,例如每天 1000 个请求。
  • 以更高的价格发布第三个 API 产品,具有同一 API 资源的读写权限,但具有较高的访问限制。

请务必注意,Apigee 可让您灵活地创建符合 API 业务要求的 API 产品。

如需详细了解如何创建 API 产品,请参阅管理 API 产品

任务 2:注册应用开发者

开发者创建使用您的 API 的应用。应用开发者必须先在 Apigee 注册,然后才能注册应用。注册应用时,他们会收到一个 API 密钥,用来授予应用对 API 的访问权限。

通过应用注册流程,您可以控制哪些用户可以访问您的 API。您可以随时删除应用开发者,此操作会使该开发者关联的所有 API 密钥都失效,从而拒绝该开发者访问您的 API。

显示开发者、应用、API 和后端服务的从左到右的序列图。突出显示开发者图标。虚线从突出显示的开发者指向开发者已构建的应用的图标。从应用出发的箭头和指向应用的箭头表示到 API 图标的请求和响应流,请求上方显示应用密钥。API 图标下是两组资源路径,分为两个 API 产品:位置产品和媒体产品。位置产品具有 /countries、/cities、/languages 资源,媒体产品具有 /books、/magazines、/movies 资源。API 的右侧是 API 调用的后端资源,包括数据库、企业服务总线、应用服务器和通用后端。

作为 API 提供方,您可以决定如何注册开发者。例如,您可以使用手动注册流程,这要求潜在开发者联系您的组织进行注册。潜在开发者必须提供所有必要的信息,例如电子邮件地址、名字和姓氏以及公司名称。如果您批准开发者的请求,则可以使用 Apigee 界面手动注册开发者。如下了解详情,请参阅注册应用开发者

任务 3:注册开发者应用

必须先注册应用,然后应用才能访问您的 API。但是,只有已注册开发者才能注册应用。

显示开发者、应用、API 和后端服务的从左到右的序列图。突出显示应用、请求/响应和 API 密钥箭头。虚线从开发者指向开发者已构建的应用的图标。从应用出发的箭头和指向应用的箭头表示到 API 图标的请求和响应流,请求上方显示应用密钥。突出显示 API 图标和资源。API 图标下是两组资源路径,分为两个 API 产品:位置产品和媒体产品。位置产品具有 /countries、/cities、/languages 资源,媒体产品具有 /books、/magazines、/movies 资源。API 的右侧是 API 调用的后端资源,包括数据库、企业服务总线、应用服务器和通用后端。

在注册应用时,开发者可选择一个或多个 API 产品。例如,您可以发布与不同类型的服务和价格方案对应的多个 API 产品。之后。应用开发者接着可以从可用 API 产品列表中选择和选取。

作为对在 Apigee 上注册应用的响应,Apigee 会为应用分配唯一的 API 密钥。应用必须将该 API 密钥作为每个请求的一部分传递到 API 资源。该密钥已经过身份验证,如果有效,则会授予请求。作为服务提供商,您可以随时撤消密钥,以使该应用无法再访问您的 API。

作为 API 提供方,您可以决定要如何注册应用。您可以执行以下操作:

  • 使用要求开发者联系您的组织以注册其应用的手动流程。作为响应,您可通过电子邮件向开发者发送 API 密钥。
  • 使用 Apigee API 将应用注册功能和密钥交付集成到您的网站中。
  • 对于付费 Apigee 帐号,请使用具有内置应用注册和 API 密钥交付支持的 Apigee 开发者服务门户。

如需了解详情,请参阅注册应用和管理 API 密钥

任务 4:记录您的 API

发布 API 产品的一项重要考虑因素是提供文档和开发者反馈机制。具有社交发布功能的开发者门户正日益用于与开发社区进行通信。这包括传达静态内容(例如 API 文档、使用条款),以及社区贡献的动态内容(如博客和论坛),以及客户支持功能。

显示开发者、应用、API 和后端服务的从左到右的序列图。突出显示开发者图标。开发者下方有一个框,表示开发者门户。门户包含 API 文档、示例、教程、API 参考等。门户网站还包含博客、论坛和支持门户。虚线从突出显示的开发者指向开发者已构建的应用的图标。从应用出发的箭头和指向应用的箭头表示到 API 图标的请求和响应流,请求上方显示应用密钥。API 图标下是两组资源路径,分为两个 API 产品:位置产品和媒体产品。位置产品具有 /countries、/cities、/languages 资源,媒体产品具有 /books、/magazines、/movies 资源。API 的右侧是 API 调用的后端资源,包括数据库、企业服务总线、应用服务器和通用后端。

您可以构建自己的网站来部署文档;或者,如果您有付费 Apigee 帐号,则可以使用 Apigee Developer Services 门户。该门户内置了对文档、博客、论坛和支持开发者社区所需的其他类型的内容的支持。

借助 SmartDocs,您可以采用让 API 文档完全互动的形式在开发者服务门户上记录您的 API。借助 SmartDocs 的互动式文档,门户用户可以:

  • 了解 API
  • 向 API 发送实时请求
  • 查看从 API 返回的实时响应

如需了解详情,请参阅以下几个部分: