DTK API

Rest-API для ZasLogistics на Dart. Является точкой входа для интеграции в систему ZAS из внешних систем. Клиентские приложения общаются с этим только опосредованно - через Hasura. Содержим методы для Umbrella, а также вендоров-партнеров(OMNI, JER и др.). Занимается такими задачами как: формирование расписания, автоматическая установка водителей, расчет загрузки водителей, добавление, удаление и редактирование заказов в Zas, автообновление статусов заказа и другими.

Среды

stage

Проект: umbrella-courier-stage-01

Сервис: dtk-api-server

URL: api-stage.zaslogistica.com/

Swagger:

URL: api-stage.zaslogistica.com/docs/

production

Проект: umbrella-courier

Сервис: dtk-api-server

URL: api.zaslogistica.com/

Swagger:

URL: api.zaslogistica.com/docs/

Зависимости

dtk_api главным образом общается с базой данных Hasura. Помимо обращения к бд занимается обработкой запросов из Hasura Events и Hasura Actions.

Локальный запуск

Для запуска приложения нужны переменные окружения, которые можно передать при запуске dart run через флаги --define=ENV_NAME=ENV_VALUE. Необходимый список переменных можно посмотреть в файле /lib/config.dart.

Документация

Чтобы сгенерировать документацию нужно запустить команды:

1. dart pub get - зависимости.
2. dart doc - генерация доки.
3. dart pub global activate dhttpd
4. dart pub global run dhttpd --path doc/api - запуск документации локально.