Skip to content

oarer/weather-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Weather Widget

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

Данные получаются через GET-запрос к: https://weather.murchikov.ru/v1/weather

Огромное спасибо Мурчикову за размещение API <3

Все ответы, полученные с этого endpoint'а, кэшируются на 30 минут независимо от заголовка Cache-Control.


📚 Оглавление


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

Параметры запроса

Название Описание По умолчанию Возможные значения Обязательный
place Название населённого пункта (любым языком), например: Москва, Tokyo - Строка ✅ Да
lang Язык, используемый в виджете ru Зависит от темы ❌ Нет
theme Тема оформления виджета (без этого параметра ответ будет в json формате) 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.

❗ Если в ответе есть UUID ошибки, обязательно приложите его при создании Issue — это поможет с отладкой.


Темы

default

  • Оформлена в тёмном стиле GitHub.
  • Отображает максимум информации о погоде.
  • Автор: @Andcool-Systems

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

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

Параметры

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

Пример темы

default theme


pixel-city

Города в стиле пиксель-арта.

  • Изображения сгенерированы нейросетью SDXL 1.0 (Stable Diffusion).
  • Автор: @Wavy-Cat

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

ru, en, it, es/sp, ua/uk, de, pt, ro, pl,
fi, nl, fr, bg, sv/se, zh/zh_cn, zh_tw, tr, hr, ca

Параметры

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

Пример темы

city theme

About

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

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%