Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 1.95 KB

README.md

File metadata and controls

84 lines (59 loc) · 1.95 KB

YaCut

Описание

Сервис для укорачивания URL-адресов.

Технологии

Запуск проекта на Linux

  • Склонируйте репозиторий и перейдите в директорию проекта
git clone https://github.com/mign0n/yacut.git && cd yacut
  • Установите и активируйте виртуальное окружение
python -m venv venv && source venv/bin/activate
  • Установите зависимости из файла requirements.txt
pip install -r requirements.txt
  • Создайте .env файл (при необходимости отредактируйте его)
cp .env.example .env
  • Создайте базу данных
flask db upgrade
flask run

API

API имеет два эндпоинта:

  1. POST /api/id/ - для создания короткой ссылки

    curl --header "content-type:application/json" \
    --data '{"url": "http://example.com/"}' \
    --request POST http://127.0.0.1:5000/api/id/
    {
      "short_link": "http://127.0.0.1:5000/o8yjhi",
      "url": "http://example.com/"
    }
    
  2. GET /api/id/{short_id}/ - для получения оригинальной ссылки по короткой

    curl --header "content-type:application/json" \
    --request GET http://127.0.0.1:5000/api/id/o8yjhi/
    {
      "url": "http://example.com/"
    }
    

Авторы