Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

第 1 章 操作 APIcast

本节介绍了使用高级 APIcast 配置时需要考虑的概念。

1.1. 映射规则
复制链接

映射规则定义了您要报告的指标或方法，具体取决于您的 API 请求。以下是映射规则示例：

映射规则
View larger image
映射规则

这个规则表示，任何以 / 开头的 GET 请求都将按 1 增加指标 命中。此规则将与您的 API 的任何请求匹配。但很可能会更改此规则，因为它过于通用。

Echo API 的以下规则显示更具体的示例：

Hello World 映射规则
View larger image
Hello World 映射规则

1.1.1. 映射规则的匹配
复制链接

映射规则的匹配通过前缀来执行，并可任意复杂（标记遵循 OpenAPI 和 ActiveDocs 规格）：

  • 映射规则必须以正斜杠(/)开头。
  • 您可以在字面字符串的路径上执行匹配项（例如： /hello）。

  • 映射规则可以包含查询字符串或正文上的参数（例如： /{word}?value={value}）。APIcast 获取参数的方式如下：

    • GET 方法：来自查询字符串。
    • POST、DELETE 或 PUT 方法：来自正文。
  • 映射规则可以包含命名通配符（例如： /{word}）。此规则将匹配占位符 {word} 中的任何内容，使请求（如 /morning ）与规则匹配。通配符可以在斜杠或斜杠与点之间出现。参数也可以包含通配符。
  • 默认情况下，根据您指定的排序，从第一个到最后一个到最后一个映射规则评估所有映射规则。如果您添加规则 /v1 ，它将与路径以 /v1 开头的请求匹配（例如： /v1/word 或 /v1/sentence）。
  • 您可以在模式的末尾添加一个美元符号($)来指定完全匹配项。例如，/v1/word$ 将仅匹配 /v1/word requests，并且不匹配 /v1/word/hello 请求。要完全匹配，还必须确保禁用了与所有(/)匹配的默认映射规则。
  • 多个映射规则可以匹配请求路径，但如果都不匹配，则会使用 HTTP 404 状态代码丢弃该请求。

1.1.2. 映射规则工作流
复制链接

映射规则有以下工作流：

  • 您可以定义一个新的映射规则（请参阅 添加映射规则）。
  • 下一次重新加载时，映射规则会灰显，以防止意外修改。
  • 要编辑现有的映射规则，您必须首先通过单击右侧的铅笔图标启用它。
  • 若要删除规则，可单击回收站图标。
  • 点 Update & Test Staging Configuration 时会保存所有修改和删除。

添加映射规则

要添加新映射规则，请执行以下步骤：

  1. 点 Add Mapping Rule。

  2. 指定以下设置：

    • 动词 ：HTTP 请求动词（GET、POST、DEL E 或 PUT）。
    • Pattern ：要匹配的模式（例如，/hello）。
    • + ：指标递增号（例如 1）。
    • 指标（或方法 ）：指标或方法名称（如 gethello）。
  3. 点击 Update & Test Test Staging Configuration 以应用更改。

停止其他映射规则

要停止处理其他映射规则，您可以选择 Last?。例如，如果您在 API Integration Settings 中定义以下映射规则，并且具有与每个规则关联的不同指标： 

(get) /path/to/example/search
(get) /path/to/example/{id}
Copy to Clipboard Toggle word wrap

在使用 (get)/path/to/example/search 调用时，APIcast 将停止处理剩余的映射规则，并在规则匹配后递增其指标。

排序映射规则

要对映射规则进行排序，您可以为 Last? 设置旁的每个映射规则使用绿色箭头来拖放它们。指定的排序保存在数据库中，并在点 Update & test in Staging Environment 后保存在代理配置中。

如需了解更多配置选项，请参阅 APIcast 高级配置。

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

Theme

© 2025 Red Hat