YanSQLAdminAPI

API сервис на sqladmin содержащий в себе веб-интерфейс для управления базой данных.

Инструация по установке и запуску

Инструкция написана для linux ubuntu 22.04, на других дистрибутивах команды могут отличаться.

1. Обновите список версий пакетов:

   sudo apt update

2. Обновите пакеты:

   sudo apt upgrade

3. Скопируйте репозиторий:

   git clone https://github.com/LoveBloodAndDiamonds/YanSQLAdminAPI.git

4. Заполните .env.example и переименуйте его в .env

   nano env.example

5. Запустите следующую команду в терминале на вашем сервере:

   curl -fsSL https://get.docker.com -o get-docker.sh

6. Затем запустите скрипт установки Docker:

   sudo sh get-docker.sh

7. После завершения установки Docker, добавьте текущего пользователя в группу docker, чтобы иметь возможность запускать Docker без использования sudo:

   sudo usermod -aG docker $USER

8. Установите Docker Compose:

   sudo curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

9. Измените разрешения для Docker Compose:

   sudo chmod +x /usr/local/bin/docker-compose

10. Запустите контейнер:

docker-compose up -d

Инструкция по использованию со стороны пользователя API

import requests

SERVER_IP: str = "127.0.0.1"  # IP сервера
API_PORT: int | str = 80  # Порт, на котором открыт API


def get_access(username: str) -> bool:
    """Функция для проверки лицензии по имени пользователя."""
    url = f"http://{SERVER_IP}:{API_PORT}/access/{username}"
    response = requests.get(url)
    
    if response.status_code != 200:
        raise requests.exceptions.ConnectionError(f"Не удалось получить ответ от сервера."
                                                  f" Код: {response.status_code}")

    result: dict[str: bool] = response.json()  # Словарь формата {"access": bool}

    return result["access"]


def your_application():
    try:
        access: bool = get_access("ghoul")

        if access:
            print("Вход в программу разрешен.")
        else:
            print("Вход в программу запрещен.")
    except requests.exceptions.ConnectionError:
        print("Ошибка соединения с сервером.")
    except Exception as e:
        print(f"Неизвестная ошибка ({type(e)}) при проверке лицензии: {e}")