Developer Portal API Product Publication
概述
本教程将引导您完成在开发者门户上创建和发布 API 产品的过程。在 APIM 中，产品将多个 API 组合在一起，并允许您定义产品级元数据，例如标题、描述、徽标和文档链接。已发布的产品将对开发者可见，以便进行发现和使用。
先决条件
- 至少有一个已部署的 API 可在您的 APIM 控制台中使用
- 管理员访问权限到 管理 > 产品管理
分步教程
步骤 1. 创建新产品
导航到 管理 > 产品管理，然后点击加号按钮。
在弹出窗口中：
- 输入产品名称：sk01
- 点击确认以继续。
步骤 2. 填写基本产品信息
创建产品后，您将被重定向到详细信息页面。
| Field | Example |
|---|---|
| 名称 | sk01（自动填充） |
| 描述 | 身份验证和用户管理 API |
| 产品介绍链接 | https://developers.skapim.co.kr/product/sk01/overview |
| 启用产品勾选 | （在开发者门户上显示） |
| 启用 API 文档链接勾选 | （在产品详细信息页面激活 API 文档访问） |
| 产品图标 | icon-sk01.png（1:1 比例，显示大小 40x40px） |
点击保存以保存基本信息。
步骤 3. 将 API 添加到产品
切换到产品详细视图中的 API 选项卡。
点击添加按钮将 API 分配给此产品。
可用的 API 字段：
| 字段 | 示例 |
|---|---|
| 项目 | mj-test-kong |
| 网关 | mj-test-kong-gateway |
| API | testFromBff0052 |
| 描述 | helloworld2222 |
| 标签 |
点击勾选图标以完成添加。
您可以：
- 添加多个 API
- 移除 API（X 图标）
- 查看或编辑每个 API（齿轮或查看图标）
第 4 步。在开发者门户上激活产品
返回产品列表，您将看到您的新条目。
| 列 | 描述 |
|---|---|
| 复选框 | 切换以在开发者门户上发布或隐藏产品 |
| 顺序 | 定义产品列表中的显示顺序（0 = 顶部） |
编辑显示位置后，点击保存顺序。
最佳实践
- 保持产品名称有意义且独特
- 使用 1:1 比例图标（40x40 像素）以保持一致的显示
- 将相关的 API 组合成一个产品以便于发现
- 使用产品介绍链接将用户连接到文档或业务概述
- 使用标签进行内部组织和前端过滤