端點徽章

使用端點徽章，您可以透過 JSON 端點提供徽章內容。內容可以是預先渲染的，也可以是即時產生的。為了在響應速度和頻寬利用率之間取得平衡，同時兼顧新鮮度，快取行為是可配置的，但必須符合 Shields 的最低要求。端點 URL 是透過查詢字串提供給 Shields 的。Shields 會擷取它並格式化徽章。

端點徽章採用單一必要的查詢參數：url，它是您的 JSON 端點的 URL。

JSON 端點回應範例

{ "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 字串 — 必要 您的 JSON 端點的 URL 範例：https://shields.redsparr0w.com/2473/monday
style 字串 可能的值： [flat, flat-square, plastic, for-the-badge, social] 如果未指定，此徽章的預設樣式為「flat」。 範例：flat
logo 字串 來自 simple-icons 的圖示 slug。您可以點擊 simple-icons 上的圖示標題來複製 slug，或者可以在 simple-icons 儲存庫中的 slugs.md 檔案中找到它們。更多資訊。 範例：appveyor
logoColor 字串 標誌的顏色（支援十六進位、rgb、rgba、hsl、hsla 和 css 命名顏色）。支援 simple-icons 標誌，但不支援自訂標誌。 範例：violet
logoSize 字串 透過設定 auto 使圖示自適應調整大小。對於某些較寬的標誌（如 amd 和 amg）很有用。支援 simple-icons 標誌，但不支援自訂標誌。 範例：auto
label 字串 覆寫預設的左側文字（空格或特殊字元需要 URL 編碼！） 範例：healthiness
labelColor 字串 左側部分的背景顏色（支援十六進位、rgb、rgba、hsl、hsla 和 css 命名顏色）。 範例：abcdef
color 字串 右側部分的背景顏色（支援十六進位、rgb、rgba、hsl、hsla 和 css 命名顏色）。 範例：fedcba
cacheSeconds 字串 HTTP 快取生命週期（規則適用於推斷每個徽章的預設值，任何低於預設值的值都將被忽略）。 範例：3600
link 字串[] 指定點擊徽章的左側/右側應該執行的操作。請注意，這僅在將您的徽章整合到 <object> HTML 標籤中時有效，而不是 <img> 標籤或標記語言。