voucher pool api

Служба API пула ваучеров (slimframework)

Простое приложение-служба API для использования ваучеров из пула. Это для демонстрационных целей и создано для демонстрации навыков архитектуры и программирования.

Обзор:

• Контейнер Nginx: этот сервис будет действовать как шлюз API и будет маршрутизировать все вызовы к соответствующим сервисам, например PHP-FPM.
• Контейнер PHP-FPM: этот сервис будет обслуживать все конечные точки API, связанные с ваучерами.
• Контейнер MySQL: в этом контейнере базы данных будут храниться все данные, связанные с ваучерами, поэтому к ним будет обращаться и использовать контейнер php-fpm.

Ниже приведены ключевые моменты проектирования, а также то, как они были реализованы и реализованы.

Пакеты в зависимости от управления:

Composer используется для управления всеми зависимостями приложения. Все необходимые пакеты/библиотеки объявлены в файле composer.json . И может быть установлен с помощью команды composer install .

Точка входа в приложение:

Запись приложения указывает на public каталог, который содержит только файл index.php , а также может содержать файлы ресурсов, к которым можно получить общий доступ. Кроме этого, прямой доступ к коду или файлу за пределами этой папки невозможен. Идея состоит в том, чтобы защитить все файлы за пределами этого каталога.

Простая маршрутизация с поддержкой промежуточного программного обеспечения:

Все запросы и способы их обработки определены в routes/api.php .

База данных и миграция:

Для взаимодействия с MySQL мы использовали базу данных Illuminate, также известную как «Eloquent». Это позволяет нам взаимодействовать с нашей базой данных через реляционное сопоставление объектов «ORM».

Для миграции и заполнения базы данных мы использовали независимый от платформы пакет Phinx. С течением времени код приложения развивается, и вместе с ним развивается база данных. Чтобы отслеживать изменения кода, мы используем инструменты управления версиями исходного кода, такие как git. С помощью сценариев миграции мы также можем отслеживать изменения базы данных. Особенно полезно при работе в команде. Когда коллеги по команде извлекают ваши изменения и видят сценарии миграции, они могут просто запустить их с помощью простой команды, чтобы обновить изменения схемы локальной базы данных.

Внедрение зависимостей классов и сервисный контейнер:

Для управления зависимостями классов и выполнения внедрения зависимостей мы использовали SlimFramwork Container . Благодаря этому мы можем инвертировать управление зависимостями от приложения к классу, отсюда и шаблон «Инверсия управления».

Простое управление конфигурацией приложений и переменные среды:

Для управления настройками конфигурации приложения мы использовали файл Illuminate Config. Все конфигурации хранятся в каталоге config . Также использовался Symfony Dotenv для загрузки переменных, определенных в файле .env , а затем доступа к ним через функцию getenv(). Полезно иметь разные параметры конфигурации для каждой среды, т. е. разработки, промежуточной и производственной среды.

Контекстное ведение журнала:

Чтобы понять, что происходит в нашем приложении, мы использовали библиотеку Monolog, которая предоставляет надежные службы ведения журналов, позволяющие регистрировать сообщения.

Проверка HTTP-запроса:

Для проверки данных входящего HTTP-запроса вашего приложения мы использовали Illuminate Validation, которая предоставляет множество мощных правил проверки.

Стандартный и последовательный вывод HTTP-ответа API:

Чтобы обеспечить стандартный и согласованный вывод данных ответов API, мы использовали League Fractal, поэтому у нас может быть уровень представления и преобразования для наших выходных данных. Все классы трансформации хранятся в каталоге app/Transformers .

Хэш-идентификаторы для генерации ваучеров:

При создании нового специального предложения мы не создаем ваучеры для всех получателей в нашей системе. Вместо этого мы используем HashIds для создания и проверки ваучеров для каждого получателя. Мы можем кодировать и декодировать, используя комбинацию [{recipient_id}, {offer_id}] . Он всегда создает код ваучера, состоящий ровно из 8 символов, который также можно обновить в файле config/hashids.php

Тестирование:

Для тестирования нашей службы приложений мы использовали Codeception. Он сразу же позволяет нам проводить все три типа тестов: модульные, функциональные и приемочные тесты в единой среде. В нашем случае мы провели модульное тестирование основных бизнес-объектов в AppServices , а также написали приемочные тесты для проверки интеграции и функциональности всех конечных точек API. Все тестовые примеры хранятся в каталоге tests . и может быть запущен следующей командой:

$ php vendor/bin/codecept run --steps

Стандарты кода и руководства по стилю:

Чтобы поддерживать стандарты кодирования в команде, я создал файл phpcs.xml , в котором определены все стандарты кодирования. и все файлы кода можно проверить по этому файлу, выполнив следующую команду:

$ php vendor/bin/phpcs

Установка

Требования к среде разработки:

• Гит
• Докер >= 18.09 н. э.
• Докер Составление

Настройка среды разработки на локальном компьютере с помощью сценария установки (для MAC/LINUX) :

git clone https://github.com/ahsanatiq/voucher-pool-api.git
cd voucher-pool-api
./setup.sh

Ручная настройка (для Windows) :

git clone https://github.com/ahsanatiq/voucher-pool-api.git
cd voucher-pool-api
cp .env.dev .env
docker-compose up -d
docker exec -it voucher-pool-php-fpm composer install
docker exec -it voucher-pool-mysql mysql -u root -pnewsletter2go -e " create database newsletter2go_testing; GRANT ALL PRIVILEGES ON *.* TO 'newsletter2go'@'%' IDENTIFIED BY 'newsletter2go'; " ;
docker exec -it voucher-pool-php-fpm php vendor/bin/phinx migrate
docker exec -it voucher-pool-php-fpm php vendor/bin/phinx seed:run

Теперь вы можете получить доступ к приложению через http://localhost:8080.

Запуск тестов

Запустите модульные и приемочные тесты в сервисном контейнере PHP-FPM:

docker exec -it voucher-pool-php-fpm php vendor/bin/codecept run --steps

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

Вы можете получить доступ к общедоступной документации API на сайте Postman. Чтобы импортировать и запустить все API, нажмите «Запустить в Postman» на верхней панели. После установки и импорта вы увидите новую коллекцию как «Newsletter2Go — Voucher API».