Это документация описывает API для получения случайного изображения животного из заданной категории. API предоставляет возможность запросить случайное изображение животного, указав желаемую категорию животного. Если категория не указана, будет возвращено случайное изображение из списка поддерживаемых категорий.

git clone https://github.com/FlacSy/AnimalsAPI.git

cd AnimalsAPI

1. Виртуальное окружение

   • Создание окружение

     python3 -m venv venv 

   • Активация окружения

     Windows:

     venv\Scripts\activate

     Unix:

     source venv/bin/activate

2. Установка зависимостей

   • Windows:

     pip install -r requirements.txt

   • Unix:

     pip3 install -r requirements.txt
     
     

• GET

• animal (строка, необязательный): Категория животного. Если не указана, будет выбрано случайное животное из списка поддерживаемых категорий.

{
    "image_url": "http://127.0.0.1:5000/animals/{animal}/{filename}.jpg",
    "request_type": "GET",
    "requested_animal": "{animal}",
    "status_code": 200
}

• 400 Bad Request: В случае, если параметр animal указан неверно или не существует. В ответе будет предоставлено сообщение об ошибке и список поддерживаемых параметров.

• GET

Этот эндпоинт предназначен для получения изображения животного по указанному пути.

Для запуска приложения выполните следующую команду:

python app.py

Для работы приложения требуется наличие конфигурационного файла config.py, содержащего путь к папке с изображениями животных и список поддерживаемых категорий животных.

{
    'path': {
        'animals': '/путь/к/папке/с/папками/изображений/'
    },
    'animals': {
        'support': ['категория_1', 'категория_2', ...]
    }
}