跳到主要内容

API Creation and Deployment

概念​

什么是API？​

一个 API (Application Programming Interface) 是一组定义和协议，允许软件应用程序彼此通信。在 APIM (API Management) 的上下文中，API 代表一组可以被客户端调用的操作，便于访问后端服务。

为什么要创建API？​

创建API为提供者和消费者都带来了几个好处：

对于提供者：

  • 模块化：将功能封装为可重用的服务。
  • 可扩展性：促进可扩展应用程序的开发。
  • 安全性：实施访问控制和监控。
  • 盈利：将API作为产品提供给外部开发者或合作伙伴。

对于消费者：

  • 可访问性：在不理解内部实现的情况下访问服务。
  • 效率：快速将功能集成到应用程序中。
  • 创新：通过组合现有API构建新解决方案。

API在APIM和Kong Gateway中的作用​

在APIM中，API作为客户端与后端服务之间的主要接口。它们：

  • 定义客户端如何与服务交互。
  • 强制执行身份验证、速率限制和转换等政策。
  • 监控使用情况和性能指标。

每个API与特定项目相关联，并通过网关部署，网关作为处理API请求的运行时组件。

Kong Gateway通过提供以下功能增强API管理：

  • 高级路由：根据各种标准直接请求。
  • 安全性：实施身份验证、授权和加密。
  • 可观察性：监控API使用情况和性能。
  • 可扩展性：通过插件添加功能。

通过APIM创建API的优势​

没有APIM管理API的挑战​

在传统环境中，直接在像Kong这样的网关上创建API（通过CLI、REST API或配置文件）通常会面临几个限制：

  • 手动配置开销：每个API必须手动定义，增加了人为错误和不一致的风险。
  • 缺乏中央可见性：开发者和管理员缺乏管理、审计或审查所有注册API的单一视图。
  • 分散的政策管理：安全政策、速率限制和请求/响应转换必须逐个API手动应用，没有版本控制或历史记录。
  • 限制的协作：没有共享平台，开发者、测试者和管理者之间的协作变得低效。
  • 没有生命周期支持：管理API版本、在部署前进行测试或跟踪更改繁琐，需要自定义脚本或外部工具。

随着API数量的增加，或者在多个团队或环境中工作时，这些问题变得更加严重。

APIM如何解决这些问题​

APIM系统在Kong Gateway之上提供了强大的管理层，提供了一种简化和可扩展的API管理方式。其好处包括：

  • 可视化界面：用户可以通过用户友好的Web控制台创建、配置和部署API——无需使用CLI或手动编辑配置文件。
  • 集中API注册：所有API按项目管理，允许明确的所有权、隔离和治理。
  • 集成政策应用：在API配置期间轻松附加安全、限流、日志记录和转换政策，并具有明确的版本控制。
  • 无缝部署：一键部署到项目特定的网关，减少错误并支持分阶段环境。
  • 内置版本控制和文档：API可以在同一环境中进行版本控制、测试和文档编写，提高可维护性。
  • 团队协作：通过基于角色的访问，不同利益相关者（管理员、开发者、测试者）可以在项目边界内安全地贡献。

最终，APIM通过将Kong的运行时能力与结构化管理平台相结合，改变了API的构建和维护方式，减少了运营负担，并实现了更快、更安全的开发工作流程。

创建API的步骤​

要在APIM中创建API，请按照以下步骤操作：

访问APIM控制台​

使用您的apim-admin凭据登录。

选择适当的项目并转到API管理部分。

添加新API​

点击“+ 添加API”。选择定义API的方法。

配置API设置​

  • 名称：API的唯一标识符。
  • 网关：附加到项目的Kong网关和网关URL。
  • Web服务URL：后端服务端点。
  • API URL后缀：附加到网关URL的后缀。
  • 描述：关于API的可选详细信息。
  • 定义操作：添加操作（例如，GET、POST），指定URL路径和参数。

应用政策​

实施身份验证、速率限制、转换等政策。

编写或更新API文档​

使用内置的Markdown编辑器编写或更新您的API文档。

预览内容并点击“发布”。文档将能够在API文档菜单中显示，并通过开发者门户对授权用户可访问。

将API保存到API管理中​

保存API配置并在API管理屏幕中查看创建的API。

备注

有关详细说明和其他选项，请参阅用户指南 > APIM控制台指南 > API管理

API部署​

成功创建API后，您可以点击创建的API以访问API配置屏幕。在这里，您可以点击API部署按钮以部署API，使其可外部访问。

每次API的部署将生成一个新版本。每次执行API的部署时，您都需要输入版本描述。

API部署后，用户可以通过API部署菜单监控API状态和部署日志。

用户还可以点击每个单独的API部署记录以查看API及其版本的详细信息。

完成此步骤后，API现在在网关上处于活动状态，并可以通过其公共端点URL访问。您现在可以继续进行最后一步以测试API。