Skip to content

REST API сервер

REST API сервер Data.Rentgen предоставляет простой HTTP API для доступа к сущностям, хранящимся в базе данных. Реализован с использованием FastAPI.

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

С Docker

  • Установите Docker

  • Установите docker-compose

  • Выполните следующую команду:

$ docker compose --profile server up -d --wait
...

docker-compose загрузит все необходимые образы, создаст контейнеры и запустит сервер.

Параметры можно задать через файл .env или раздел environment в docker-compose.yml

docker-compose.yml 
1
.env.docker

ini hl_lines="22-27" linenums="1"

Без Docker

  • Установите Python 3.10 или выше

  • Настройте базу данных, выполните миграции и создайте партиции

  • Создайте виртуальное окружение

$ python -m venv /some/.venv
...
$ source /some/.venv/activate
  • Установите пакет data-rentgen со следующими дополнительными зависимостями:
$ pip install data-rentgen[server,postgres]
...
  • Запустите процесс сервера
$ python -m data_rentgen.server --host 0.0.0.0 --port 8000
...

Это тонкая обёртка вокруг CLI uvicorn, параметры и команды точно такие же.

См. также