Endpoint 徽章

使用 Endpoint 徽章，您可以通过 JSON Endpoint 提供徽章内容。 内容可以预先渲染，也可以动态生成。 为了在响应速度和带宽利用率以及新鲜度之间取得平衡，缓存行为是可配置的，但需遵循 Shields 的最低要求。 Endpoint URL 通过查询字符串提供给 Shields。 Shields 会获取它并格式化徽章。

Endpoint 徽章需要一个必需的查询参数：url，它是 JSON Endpoint 的 URL

示例 JSON Endpoint 响应

{ "schemaVersion": 1, "label": "hello", "message": "sweet world", "color": "orange" }

示例 Shields 响应

模式

属性	描述
schemaVersion	必需。 始终为数字 1。
label	必需。 左侧文本，或空字符串以省略徽章的左侧。 这可以通过查询字符串覆盖。
message	必需。 不能为空。 右侧文本。
color	默认：lightgrey。 右侧颜色。 支持上面八种命名颜色，以及十六进制、RGB、RGBA、HSL、HSLA 和 CSS 命名颜色。 这可以通过查询字符串覆盖。
labelColor	默认：grey。 左侧颜色。 这可以通过查询字符串覆盖。
isError	默认：false。 true 表示将其视为错误徽章。 这将阻止用户覆盖颜色。 未来，它可能会影响缓存行为。
namedLogo	默认：无。 simple-icons 中的一个 slug。 这可以通过查询字符串覆盖。
logoSvg	默认：无。 包含自定义徽标的 SVG 字符串。
logoColor	默认：无。 与查询字符串含义相同。 这可以通过查询字符串覆盖。 仅适用于 simple-icons 徽标。
logoWidth	默认：无。 与查询字符串含义相同。 这可以通过查询字符串覆盖。
style	默认：flat。 要使用的默认模板。 这可以通过查询字符串覆盖。

查询参数
url string — 必需 JSON Endpoint 的 URL 示例：https://shields.redsparr0w.com/2473/monday
style string 可能的值： [flat, flat-square, plastic, for-the-badge, social] 如果未指定，此徽章的默认样式为“flat”。 示例：flat
logo string 来自 simple-icons 的图标 slug。 您可以点击 simple-icons 上的图标标题复制 slug，或者它们可以在 simple-icons 代码库的 slugs.md 文件 中找到。 更多信息. 示例：appveyor
logoColor string 徽标的颜色（支持十六进制、RGB、RGBA、HSL、HSLA 和 CSS 命名颜色）。 支持 simple-icons 徽标，但不支持自定义徽标。 示例：violet
logoSize string 通过设置 auto 使图标自适应调整大小。 对一些较宽的徽标（如 amd 和 amg）很有用。 支持 simple-icons 徽标，但不支持自定义徽标。 示例：auto
label string 覆盖默认的左侧文本（URL 编码 对于空格或特殊字符是必需的！）。 示例：healthiness
labelColor string 左侧部分的背景颜色（支持十六进制、RGB、RGBA、HSL、HSLA 和 CSS 命名颜色）。 示例：abcdef
color string 右侧部分的背景颜色（支持十六进制、RGB、RGBA、HSL、HSLA 和 CSS 命名颜色）。 示例：fedcba
cacheSeconds string HTTP 缓存生命周期（规则适用于推断每个徽章的默认值，低于默认值的任何指定值都将被忽略）。 示例：3600
link string[] 指定点击徽章的左侧/右侧应该做什么。 请注意，这仅在将徽章集成到 <object> HTML 标签中时才有效，而不适用于 <img> 标签或标记语言。