Endpoint Badge

Используя конечную точку "badge", вы можете предоставить содержимое для значка через JSON-эндпоинт. Содержимое может быть заранее подготовлено или сгенерировано в процессе запроса. Чтобы достичь баланса между отзывчивостью и использованием пропускной способности с одной стороны и свежестью данных с другой, поведение кеширования можно настроить, с учетом минимальных требований Shields. URL конечной точки передается в Shields через строку запроса. Shields извлекает его и форматирует значок.

Конечная точка "badge" принимает один обязательный параметр запроса: url, который представляет собой URL вашего JSON-эндпоинта.

Пример ответа JSON-эндпоинта

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

Пример ответа Shields

Схема

Свойство	Описание
schemaVersion	Обязательное. Всегда число 1.
label	Обязательное. Левый текст, или пустая строка для исключения левой части значка. Это можно переопределить через строку запроса.
message	Обязательное. Не может быть пустым. Правый текст.
color	Значение по умолчанию: lightgrey. Цвет правой части. Поддерживаются восемь именованных цветов, а также hex, rgb, rgba, hsl, hsla и именованные цвета CSS. Это можно переопределить через строку запроса.
labelColor	Значение по умолчанию: grey. Цвет левой части. Это можно переопределить через строку запроса.
isError	Значение по умолчанию: false. true для обозначения ошибочного значка. Это предотвратит возможность изменения цвета. В будущем это может повлиять на поведение кеширования.
namedLogo	Значение по умолчанию: нет. Один из simple-icons слегов. Может быть переопределено через строку запроса.
logoSvg	Значение по умолчанию: нет. Строка SVG, содержащая пользовательский логотип.
logoColor	Значение по умолчанию: нет. То же значение, что и в строке запроса. Может быть переопределено через строку запроса. Работает только для логотипов из simple-icons.
logoSize	Значение по умолчанию: нет. Дает возможность адаптивного изменения размера значков, установив auto. Полезно для более широких логотипов, таких как amd и amg. Поддерживается только для логотипов из simple-icons.
logoWidth	Значение по умолчанию: нет. То же значение, что и в строке запроса. Может быть переопределено через строку запроса.
style	Значение по умолчанию: flat. Шаблон по умолчанию. Может быть переопределено через строку запроса.

Query Parameters
url string — REQUIRED URL-адрес вашей конечной точки JSON Example: https://shields.redsparr0w.com/2473/monday
style string Possible values: [flat, flat-square, plastic, for-the-badge, social] Если не указано, стиль по умолчанию для этого значка будет "flat". Example: flat
logo string Иконка из simple-icons. Вы можете щелкнуть по названию иконки на simple-icons, чтобы скопировать slug, или они могут быть найдены в файле slugs.md в репозитории simple-icons. Дополнительная информация. Example: appveyor
logoColor string Цвет логотипа (hex, rgb, rgba, hsl, hsla и css-названия цветов поддерживаются). Поддерживается для логотипов simple-icons, но не для кастомных логотипов. Example: violet
logoSize string Настройте адаптивный размер иконок, установив значение auto. Это полезно для более широких логотипов, таких как amd и amg. Поддерживается для логотипов simple-icons, но не для кастомных логотипов. Example: auto
label string Переопределите текст на левой части значка (URL-encoded для пробелов или специальных символов!). Example: healthiness
labelColor string Цвет фона левой части (поддерживаются hex, rgb, rgba, hsl, hsla и css-названия цветов). Example: abcdef
color string Цвет фона правой части (поддерживаются hex, rgb, rgba, hsl, hsla и css-названия цветов). Example: fedcba
cacheSeconds string Время жизни HTTP-кэша (правила применяются для вычисления значения по умолчанию для каждого значка, любые указанные значения, ниже значения по умолчанию, будут игнорироваться). Example: 3600
link string[] Укажите, что должно происходить при клике на левую/правую часть значка. Обратите внимание, что это работает только при интеграции значка в тег HTML <object>, но не в тег <img> или разметку.