Проекты/UptimeKumaAPI - История изменений

Nikolay в 11:59, 14 мая 2023

2023-05-14T11:59:33Z

Nikolay в 11:59, 14 мая 2023

2023-05-14T11:59:22Z

Nikolay в 11:58, 14 мая 2023

2023-05-14T11:58:41Z

Nikolay: Новая страница: «==Информация о проекте== UptimeKumaAPI - библиотека с открытым исходным кодом для разработчиков...»

2023-05-14T11:44:11Z

Новая страница: «==Информация о проекте== UptimeKumaAPI - библиотека с открытым исходным кодом для разработчиков...»

Новая страница

==Информация о проекте==
UptimeKumaAPI - библиотека с открытым исходным кодом для разработчиков на платформе .NET(языки программирования C#, VB.NET, F#), позволяющая работать с API скрипта для мониторинга работы сервисов и прочих систем — [https://github.com/louislam/uptime-kuma Uptime Kuma]. В данный момент присутствуют функции, доступные обычному пользователю: получение данных, конфигурации и подобного. API для работы с административными функциями будет добавлено в следующей версии.

<strong>Актуальная версия:</strong> 1.0

==Скачивание==
Скачать библиотеку можно с [https://unkov.su/projects/uptime-kuma-api-dotnet/ официального сайта Unkov].

@@ Строка 10: / Строка 10: @@
 ===Начало использования библиотеки===
 ) Если библиотека скачана в виде .dll файла:
 - Добавить .dll файл в "Ссылки" к проекту в обозревателе решений Visual Studio.

@@ Строка 10: / Строка 10: @@
 ===Начало использования библиотеки===
 ) Если библиотека скачана в виде .dll файла:
 - Добавить .dll файл в "Ссылки" к проекту в обозревателе решений Visual Studio.
 Если библиотека скачана с NuGet, встроенного в Visual Studio, вышеуказанного делать <strong>не нужно</strong>
 ) Необходимо инициализировать библиотеку с помощью ``using``. Например, <code>using UptimeKumaAPI;</code>
 ) Теперь нужно создать объект главного класса библиотеки. Например, <code>var hub = new KumaAPIHub("https://uptime.unkov.su/");</code>
 ===Функции===
 <code>string GetStatusPageConfig(string statusPage = "default")</code> - ``Получить конфигурацию страницы статуса``
 <code>string GetStatusPageIncident(string statusPage = "default")</code> - ``Получить инцидент со страницы статуса``
 <code>string GetStatusPagePublicGroupList(string statusPage = "default")</code> - ``Получить публичный групповой лист страницы статуса``
 <code>string GetMonitorsHearbeatList(string statusPage = "default")</code> - ``Получить список пинга мониторов со страницы статуса``
 <code>string GetMonitorsUptimeList(string statusPage = "default")</code> - ``Получить аптайм мониторов со страницы статуса``
 <code>bool Push(string code, string status = "up", string msg = "OK", string ping = "")</code> - ``Сделать пуш в монитор страницы статуса``
 <code>string GetEntryPage()</code> - ``Получить входную страницу``
 <code>string GetStatusBadge(int monitor)</code> - ``Получить значок статуса монитора``
 <code>string GetUptimeBadge(int monitor, int hours)</code> - ``Получить значок аптайма монитора``
 <code>string GetPingBadge(int monitor, int hours)</code> - ``Получить значок пинга монитора``

← Предыдущая		Версия 11:58, 14 мая 2023
Строка 6:		Строка 6:
	==Скачивание==		==Скачивание==
	Скачать библиотеку можно с [https://unkov.su/projects/uptime-kuma-api-dotnet/ официального сайта Unkov].		Скачать библиотеку можно с [https://unkov.su/projects/uptime-kuma-api-dotnet/ официального сайта Unkov].
		+
		+	==Документация==
		+	===Начало использования библиотеки===
		+	1) Если библиотека скачана в виде .dll файла:
		+	- Добавить .dll файл в "Ссылки" к проекту в обозревателе решений Visual Studio.
		+	Если библиотека скачана с NuGet, встроенного в Visual Studio, вышеуказанного делать <strong>не нужно</strong>
		+	2) Необходимо инициализировать библиотеку с помощью ``using``. Например, <code>using UptimeKumaAPI;</code>
		+	3) Теперь нужно создать объект главного класса библиотеки. Например, <code>var hub = new KumaAPIHub("https://uptime.unkov.su/");</code>
		+	===Функции===
		+	<code>string GetStatusPageConfig(string statusPage = "default")</code> - ``Получить конфигурацию страницы статуса``
		+	<code>string GetStatusPageIncident(string statusPage = "default")</code> - ``Получить инцидент со страницы статуса``
		+	<code>string GetStatusPagePublicGroupList(string statusPage = "default")</code> - ``Получить публичный групповой лист страницы статуса``
		+	<code>string GetMonitorsHearbeatList(string statusPage = "default")</code> - ``Получить список пинга мониторов со страницы статуса``
		+	<code>string GetMonitorsUptimeList(string statusPage = "default")</code> - ``Получить аптайм мониторов со страницы статуса``
		+	<code>bool Push(string code, string status = "up", string msg = "OK", string ping = "")</code> - ``Сделать пуш в монитор страницы статуса``
		+	<code>string GetEntryPage()</code> - ``Получить входную страницу``
		+	<code>string GetStatusBadge(int monitor)</code> - ``Получить значок статуса монитора``
		+	<code>string GetUptimeBadge(int monitor, int hours)</code> - ``Получить значок аптайма монитора``
		+	<code>string GetPingBadge(int monitor, int hours)</code> - ``Получить значок пинга монитора``