1.6. 映射规则
映射规则定义了根据对 API 的请求,要报告哪些指标(和方法)。
默认情况下,我们从非常简单的映射规则开始,
这个规则表示,任何以 /
开头的 GET
请求都将按 1 增加指标 命中
。此映射规则将与您的 API 的任何请求匹配。因为它过于通用,您很可能需要更改此规则。
APIcast 获取参数的方式如下:
- 对于 GET 方法: APIcast 从查询字符串获取参数。
- 对于任何这些方法(POST、DELETE 和 PUT): APIcast 从正文(body)获取参数。
参数也可以具有命名通配符。通配符可以在斜杠或斜杠与点之间出现。
例如,以下包括了 Echo API 的规则:
映射规则也可以包含查询字符串或正文上的参数: /{word}?value={value}
。
规则的匹配通过前缀完成,可以是任意复杂的(符号是 Swagger 和 ActiveDocs 规格)
-
您可以对字面字符串的路径进行匹配:
/hello
-
映射规则可以包含命名通配符:
/{word}
此规则将匹配占位符 {word}
中的任何内容,使请求(如 /morning
)与规则匹配。
通配符可以在斜杠或斜杠与点之间出现。
-
映射规则也可以包含查询字符串或正文上的参数:
/{word}?value={value}
当一个 GET 是 GET 且来自正文时,APIcast 将尝试从查询字符串中获取参数。
参数也可以具有命名通配符。
默认情况下,所有映射规则都会根据您指定的排序顺序从第一到最后一个评估。如果在上图的示例中添加了一个规则 /v1
,则它会匹配以其路径以 /v1 开头的请求匹配,例如 /v1/word
或 /v1/sentence
。