跳到主要内容
版本：3.9.x

构建 API 端点

API 端点为您的 API 提供实际的业务逻辑和数据。在将 API 与 API7 企业版集成之前，您需要开发并部署它们。

开发 API 端点​

本节列出了开发 API 端点的工作流程。

  1. 计划排期：计划排期是 API 开发过程中的关键环节。团队成员应根据预定的时间表完成并汇报工作，以确保项目按时交付。
  2. 开发与自测：通常，开发涉及编码和调试，而自测涉及对已开发的 API 进行测试和验证，以确保其功能正常。
  3. 集成测试：集成测试是对不同模块之间的 API 进行调试和测试的阶段，以确保交互和通信的正确与稳定。
  4. QA 测试：QA 测试（或质量保证测试）旨在在 API 发布之前发现并消除缺陷或漏洞。它对 API 的可靠性和安全性至关重要。
  5. 产品验收：产品验收涉及全面的测试、评估和确认，以确定 API 是否达到预期的目标和标准。此阶段对于确保 API 已准备好投入生产并满足您的要求至关重要。
  6. 部署：一旦 API 通过所有必要的测试和评估，它将被部署到生产环境中。然后，您就可以访问和使用该 API 了。

部署 API 后端​

部署 API 后端时，您应该考虑 API 的可扩展性、可用性、可移植性等。

  • 虚拟机：直接在虚拟机（VM）上部署服务二进制文件或包。
  • 容器：将服务打包为 Docker 容器并部署在 Kubernetes 等编排系统上。
  • Serverless：开发函数并部署在如 AWS Lambda 等无服务器平台上。
  • 本地部署：在现有的本地基础设施上托管服务。

定义 API 端点​

部署完成后，必须为 API 后端配置网络端点，以便 API7 企业版能够将请求路由至该后端。

  • 虚拟机：分配公网 IP 地址并在虚拟机的防火墙上为服务端点开放端口。
  • 容器：使用 Kubernetes Ingress 或 LoadBalancer 服务来暴露端点。
  • Serverless：大多数 Serverless 平台会自动为函数分配调用 URL。
  • 本地部署：为本地服务定义带端口的 URL 或 IP 地址，并将 API7 企业版的 IP 地址加入白名单。

探测 API 后端​

您可以使用以下任一方式来探测 API 后端：

  • 实现健康检查（强烈推荐）

    为后端服务配置健康检查端点，使 API7 企业版能够检测其可用性并据此路由流量。

  • 使用服务发现（可选）

    可以使用服务发现机制（如 Consul、Eureka、Nacos 或 Kubernetes Service Discovery）来动态探测后端节点。