跳到主要内容

访问创建API界面

从 API List 页面，点击右上角的 Create API 按钮。

步骤 1：填写创建API表单

REST API选项卡​

基本配置​

  • API Name (必填): API标识符。
  • Project (必填)：选择一个项目。
  • Cluster (必填)：选择所选项目下的集群。
  • Namespace (必填)：选择所选集群下的命名空间。

标签​

用户可以为API列表添加多个标签以进行过滤。

  • 点击 Add tag 并输入 Key 和值：

  • 支持多个标签。

监听器​

  • Gateway (必填)：选择将要暴露此API的网关。

路径​

  • Path Prefix (必填)：输入要暴露的路径前缀（例如，/api/v1/my-service）。

后端​

  • Host：输入上游后端的主机名或IP地址（例如，api.example.com，10.0.0.12）。
  • Port：输入上游后端暴露的服务端口（例如，80，443，8080）。

认证​

Basic Tab
  • Authentication：
    • 选择用于验证请求的认证方法。（API密钥或JWT/OIDC）
    • 使用切换开关启用/禁用此API的访问控制。
    • Secret Name (必填)：选择存储用于验证传入请求的API密钥的密钥。
      • 创建密钥（+图标）：创建一个新密钥，然后为此策略选择它。
  • 刷新 (↻ 图标): 从系统重新加载秘密列表。
  • Rate Limiting:
    • 使用切换启用/禁用此 API 的请求速率限制。
    • Limit: 设置每个配置时间窗口允许的最大请求速率。
  • CORS:
    • 使用切换启用/禁用跨源资源共享 (CORS)，以允许基于浏览器的跨源请求。
Custom Tab
  • Search: 按关键字搜索可用的策略功能。
  • Feature cards:
    • Feature name: 要应用于 API 的策略功能。
    • Status: 指示该功能当前是否已为此 API 启用 (未激活/激活)。
    • Description: 功能的摘要。
    • Add: 将该功能添加到此 API（然后根据需要进行配置）。

实时预览面板​

在右侧，LIVE PREVIEW 面板会根据您当前的输入立即更新：

  • Endpoint: 从当前主机名和路径前缀构建的端点 URL。
  • Code snippets (cURL/Python/JS): 请求示例。
  • Configuration: 显示关键值 (API 名称 / 项目 / 集群 / 网关 / 后端 / 路径前缀)。任何缺失的值显示为 Not set。
  • Authentication: 显示当前的身份验证方法。
  • Checklist: 显示进度，以帮助确保完成所需的步骤。

LLM 选项卡​

基本配置​

  • API Name (必填): API 标识符。
  • Description: 关于 API 的简短描述。
  • Project (必填): 选择一个项目。
  • Cluster (必填): 在所选项目下选择一个集群。
  • Namespace (必填): 在所选集群下选择一个命名空间。

标签​

用户可以为 API 列表添加多个标签以进行过滤。

  • 点击 Add tag 并输入 Key 和值：

  • 支持多个标签。

监听器​

  • Gateway （必填）：选择此 API 将要暴露的网关。

模型来源​

选择模型的服务来源：

  • Self-Hosted Model (CLUSTER)：使用在您的 Kubernetes 集群中运行的模型。
  • Public Model (CLOUD)：连接到外部 LLM 提供商（例如，OpenAI/Anthropic）。

模型​

  • Model Entry：
    • Select from Cluster：选择在集群中注册的模型。
    • Enter Manually：手动输入模型名称。
  • Model：要服务的目标模型。

认证​

  • API Key：使用切换启用/禁用此 API 的 API 密钥保护。
  • Secret Name （当 API 密钥开启时必填）：选择存储用于验证请求的 API 密钥的秘密。

第 2 步：保存或取消​

  • 完成表单后，点击 Save 以创建 API。
  • 如果您想放弃更改，请点击 Cancel 并返回到 API List 页面。