Вернуться на страницу продукта

Введение

Шлюз к объектам базы данных Blitz REST API Server позволяет создавать программные интерфейсы (API) на основе архитектурного стиля REST, в качестве источника данных выступает реляционная СУБД PostgreSQL.

REST-сервисы и соответствующие таблицы в БД генерируются на основе подготовленных описаний метаданных.

Шлюз позволяет выполнять следующие операции:

  • CRUD-операции с одиночными объектами;
  • поиск объектов с помощью RQL-запросов;
  • групповые (bulk) операции с объектами: вставка, редактирование, удаление.

Созданные сервисы поддерживают:

  • работу с иерархией объектов (embed-запросы);
  • оптимистичное блокирование с использованием CAS-алгоритма.

Также шлюз позволяет настраивать процедуры (вызов внешних сервисов), исполнение которой обусловлено действием по модификации данных.

Запуск шлюза

Шлюз поставляется в виде исполняемого файла, скомпилированного под определенную ОС. Выполнение файла позволяет запустить сервер Blitz REST API Server.

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

  • a – используемый ip-адрес;
  • p – используемый порт, по умолчанию 8080;
  • r – путь, по которому будет доступен сервис. По умолчанию имеет значение "/api";
  • d – параметры соединения с PostrgeSQL базой данных в виде строки. Пример: host=infra-pdb01 user=username password=password dbname=database_test sslmode=disable

Пример запуска сервера:

./api -d "host=infra-pdb01 user=username password=password dbname=database_test sslmode=disable"