URL Shortener

Описание

Проект "URL Shortener" представляет собой простой сервис для сокращения URL-адресов. Сервис разработан на языке программирования Go и использует SQLite в качестве хранилища данных.

Как начать

Установка и Запуск

1. Клонируйте репозиторий:

   git clone <url-репозитория>

2. Перейдите в каталог проекта:

   cd <название-папки-проекта>

3. Установите переменную окружения CONFIG_PATH. В командной строке выполните:

   export CONFIG_PATH=./config/local.yaml

4. Запустите приложение с помощью Docker Compose:

   docker-compose up

Приложение будет доступно по адресу http://localhost:8080.

Конфигурация

Конфигурация приложения находится в файлах YAML в папке config. В текущей конфигурации используется файл local.yaml. Вы можете изменить конфигурацию, отредактировав соответствующий файл.

API

Сохранение URL

• Метод: POST
• Путь: /`
• Аутентификация: Базовая HTTP-аутентификация
• Тело запроса:

  {
    "url": "ваш-длинный-url-адрес",
    "alias": "опциональный-псевдоним"
  }

• Ответ: JSON с сокращенным URL-адресом

Получение оригинального URL

• Метод: GET
• Путь: /{alias}/
• Ответ: Перенаправление на оригинальный URL

Удаление URL

• Метод: DELETE
• Путь: /{alias}/
• Аутентификация: Базовая HTTP-аутентификация

Логирование

Приложение ведет логирование событий. Логи доступны в стандартном выводе Docker Compose.

Завершение работы

Для завершения работы приложения используйте команду:

docker-compose down

---

Happy URL Shortening!