注册 API

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

注册 API 之后,查看者就可以在 API 列表中发现它。

注册 API

注册 API

如需注册 API,请执行以下操作:

  1. 在 Cloud Console 中,转到 Apigee API Hub 页面。

    转到 API Hub

    默认情况下,系统会显示 API 列表页面。

  2. 点击注册 API注册 API 窗格随即会打开。
  3. 指定以下 API 详细信息:
    • ID:API 资源的标识符。ID 只能包含小写字母、数字和连字符。该 ID 在项目中必须唯一。ID 的长度必须介于 4 到 63 个字符之间。在注册 API 后,便无法更改 ID。例如,对于 API 资源名称 projects/my-project/locations/global/apis/my-api,资源 ID 为 my-api
    • 名称:输入 API 名称
    • 说明:输入 API 说明
    • 样式
      • 样式:选择 API 的主要架构样式(例如 OpenAPIGraphQLAsyncAPI 等,具体取决于 API Hub 的配置方式)。
      • API 说明文档:如果您已有说明文档,请点击浏览进行上传。这可以是单个文件或 zip 文件(最多 2 MB)。如需了解如何添加和删除修订版本,请参阅管理修订版本
      • MIME 类型:选择 MIME 类型。选择 API 说明文档后,会显示 MIME 类型。如果您选择其他,则会显示一个文本字段,您可以在其中手动指定 MIME 类型。
    • 当前版本
      • 版本 ID:API 资源的名称。版本 ID 只能包含小写字母、数字和连字符。版本 ID 在项目中必须唯一。版本 ID 的长度必须介于 1 到 63 个字符之间。在注册 API 后,便无法更改版本 ID。
      • 版本:输入初始版本
      • API 生命周期阶段:从列表中选择生命周期阶段
    • 预计的服务终止日期
      • 从列表中选择预期
      • 如果预期最早的日期,请指定日期
      • 如果预期确认的日期,请指定日期
    • 属性
      • 系统分类
        • 目标用户:选择 API 的目标用户(使用者)

        • 团队:选择负责生成 API 的团队
        • 业务部门:选择负责 API 的业务部门
      • 自定义分类
        • 选择所列的任何其他自定义分类
    • 主要联系人
      • 主要联系人电子邮件地址:有关 API 的问题的主要联系人的电子邮件地址
      • 主要联系人说明:有关主要联系人的说明
  4. 点击注册 API(或取消)。

修改 API 注册详情

如需修改 API 注册详情,请执行以下操作:

  1. 在 Cloud Console 中,转到 Apigee API Hub 页面。

    转到 API Hub

    默认情况下,系统会显示 API 列表页面。

  2. 点击一个 API。API 概览页面随即打开。
  3. 点击 修改
  4. 修改详情。
  5. 点击保存(或取消)。

删除 API

删除 API 会将其从系统中移除。如果其他人需要了解 API 的历史信息,而不是将其删除,请考虑使用弃用已放弃生命周期阶段。

要删除 API,请执行以下操作:

  1. 在 Cloud Console 中,转到 Apigee API Hub 页面。

    转到 API Hub

    默认情况下,系统会显示 API 列表页面。

  2. 点击一个 API。API 概览页面随即打开。
  3. 点击 删除 API
  4. 此时会显示一个确认对话框。输入 API 名称,然后点击确认(或取消)。

    删除 API 确认