Skip to content

Andcool-Systems/weather-widget-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Weather Widget

GitHub repo size

Виджет погоды в виде изображения, который вы можете установить куда угодно, например, в readme своего профиля GitHub.

Подробнее об API

API расположен на GET https://weather.andcool.ru/api
Все ответы, полученные с endpoint'а /api на домене weather.andcool.ru будут кэшироваться на 2 часа, вне зависимости от переданного cache-control хедера.

Для упрощения создания виджета, можете использовать конструктор на сайте

Параметры

Название Описание По умолчанию Возможные значения Обязательный
place Название населённого пункта на любом языке - Строка Да
language Язык, который будет использоваться в картинке ru Зависит от темы Нет
theme Используемая тема виджета default default, pixel-city Нет

Некоторые темы могут иметь свои обязательные или необязательные параметры. Подробнее о них можно узнать в разделе Темы.

Ошибки API

HTTP код Возвращаемый code Описание Решение ошибки
404 place_not_found Переданный населённый пункт не найден. Передать корректное место.
400 lang_not_found Переданный язык не найден. Передать язык, который поддерживает тема.
400 tz_not_found Переданный часовой пояс не найден (только в теме default). Передать корректный код временной зоны.
400 theme_not_found Переданная тема не найдена. Указать существующую тему.
500 internal_error Внутренняя ошибка (может возникнуть по разным причинам). Решения нету. Можете создать Issue с описанием проблемы.

Внутренние ошибки бывают двух видов: на уровне облачной функции, обрабатываемые в try-except и на уровне шлюза. Ошибки на уровне шлюза обычно являются более критичными, однако ошибки на уровне функции проще отследить, поэтому в Issue прикладывайте UUID код ошибки, если он присутствует.

Темы

default

Тема по умолчанию. Содержит наибольшее количество информации о погоде. Подстроена под стандартную тёмную тему GitHub. Автор: @Andcool-Systems

Поддерживаемые языки

  • Русский - ru
  • Английский - en.

Параметры

Название Описание Обязательный По умолчанию Возможные значения
timezone Часовой пояс Нет gmt0 gmt(число от -14 до 12)

Пример темы

default theme

pixel-city

Города в стиле pixel art. Нарисовано нейросетью SDXL 1.0. Автор: @wavy-cat

Поддерживаемые языки

  • Русский - ru
  • Английский - en
  • Итальянский - it
  • Испанский - es или sp
  • Украинский - ua или uk
  • Немецкий - de
  • Португальский - pt
  • Румынский - ro
  • Польский - pl
  • Финский - fi
  • Голландский - nl
  • Французский - fr
  • Болгарский - bg
  • Шведский - sv или se
  • Китайский Традиционный - zh_tw
  • Китайский Упрощённый - zh или zh_cn
  • Турецкий - tr
  • Хорватский - hr
  • Каталанский - ca

Параметры

Название Описание Обязательный По умолчанию Возможные значения
size Размер итогового изображения Нет small small (512x358), big (1024x716)

Пример темы

default theme

About

Виджет погоды для вашего профиля GitHub

Topics

Resources

License

Stars

Watchers

Forks