API Creation / Deployment / Invocation
概述
本教程演示了 APIM 中完整的 API 生命周期 - 从创建新的 API 定义、将其部署到网关，以及通过 HTTP 请求验证其调用。该过程包括常见的现实世界配置，例如设置请求路径、选择部署目标以及在部署后测试 API 响应。
先决条件
确保以下内容已就绪：
- 网关已存在并处于活动状态（例如，gateway-prod-mj）
- 您可以访问具有开发者或管理员权限的 APIM 控制台
- 已创建项目（pj-test-01）
- 至少注册了一个网关 URL（例如，https://api.sksample.co.kr/gateway-test-01）
分步教程
第 1 步. 创建新的 API
导航到 API 管理。点击创建 API
| 字段 | 示例 |
|---|---|
| API 名称 | user-service-api |
| 基础路径 | /user-service |
| 描述 | 处理用户注册和登录 |
| 可见性 | 私有 |
| 标签 | user, auth, v1 |
点击下一步以继续版本定义。
第 2 步. 定义 API 版本
| 字段 | 示例 |
|---|---|
| 版本名称 | v1.0 |
| 目标 URL（后端） | https://backend.sksample.co.kr/user |
| 网关 | gateway-prod-mj |
| 请求方法 | GET, POST, PUT, DELETE |
| 去除基础路径 | 启用（根据后端格式可选） |
点击保存并部署。
第 3 步. 将 API 部署到网关
一旦 API 被保存：
- 转到 API 配置屏幕
- 审查并确认信息
- 点击部署（选择版本 v1.0）
- 等待状态更新为已部署。您可以在编辑后重新部署。
第 4 步. 测试已部署的 API
您可以使用任何 HTTP 客户端（Postman、curl、浏览器等）测试 API。
使用 curl 的示例测试：
curl -X GET "[https://api.sksample.co.kr/gateway-test-01/user-service/v1/status](https://api.sksample.co.kr/gateway-test-01/user-service/v1/status)"
预期响应：
{
"status": "ok",
"service": "user-service",
"version": "v1.0"
}
常见问题与故障排除
| Issue | Cause | Solution |
|---|---|---|
| 404 未找到 | 路由路径不正确 | 请仔细检查 BasePath 和 RoutePath 设置 |
| SSL 错误 | 网关没有有效证书 | 确保已启用 HTTPS 并且 TLS 证书有效 |
| 超时 | 后端目标 URL 无法访问 | 验证从网关到后端的 DNS 和网络访问 |
| 403 禁止访问 | 需要 API 密钥 | 检查是否启用了身份验证策略 |
最佳实践
- 保持 BasePath 和 RoutePath 干净且有版本（例如，/api-name/v1）
- 仅部署到经过验证的网关，并确保正确的 TLS 和基础 URL 配置
- 在与消费者共享之前，使用 curl 或 Postman 进行测试
- 使用标签进行逻辑分组（例如，公共、内部、v2）
- 维护版本历史以便回滚和迭代