payment-api

README

payment-api

Запуск

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

make up

Приложение запускается на порту 8080 по умолчанию.

Посмотреть логи запущенного приложения можно командой:

make logs

Остановить приложение можно командой:

make down

Если нужны дополнительные команды, то их описание можно посмотреть в Makefile, либо с помощью команды.

make help

Общее описание

• Приложение написано на языке Go с использованием чистой архитектуры.
• Приложение разделено на слои repository, domain, handler.
• Для хранения данных используется PostgreSQL.
• Слои domain и handler покрыты unit-тестами.
• Для приложения написаны также и интеграционные тесты.
• Для запуска приложения используется docker-compose.
• В качестве CI используется GitHub Actions.
• Для документации api написана swagger документация.
• Приложение конфигурируется с помощью .env файла и переменных окружения.
• Баланс хранится и отдаётся в копейках, чтобы избежать ошибок округления.

Использованные библиотеки и фреймворки:

• gin - для реализации REST API.
• pgxpool - для работы с PostgreSQL.
• squirrel - для генерации SQL запросов.
• envconfig - для работы с переменными окружения.
• zap - для логирования.
• goose - для миграций.
• testify - для написания unit-тестов.
• go-hit - для написания интеграционных тестов.
• gomock - для генерации моков.

Некоторые вопросы реализации и принятые решения описаны тут.

Схема БД

Описание API

Для документации api написана swagger документация, а в README приведены чуть более подробное описание и curl запросы.

Получение баланса по id пользователя

Пример запроса (заменить account_id на нужный id):

curl --request GET \
  --url http://localhost:8080/api/v1/balance/{account_id} \
  --header 'Content-Type: application/json'

Пополнение баланса

Пример запроса:

curl --request POST \
  --url http://localhost:8080/api/v1/balance/add \
  --header 'Content-Type: application/json' \
  --data '{
  "account_id": 1,
  "amount": 100
}'

Пример ответа:

{
  "balance": 100
}

Возвращается новый баланс пользователя, если пользователя с таким id не существует, то он создаётся c балансом равным переданному значению.

Перевод денег

Пример запроса:

curl --request POST \
  --url http://localhost:8080/api/v1/balance/transfer \
  --header 'Content-Type: application/json' \
  --data '{
  "sender_id": 1,
  "receiver_id": 2,
  "amount": 100
}'

Пример ответа:

{
  "sender_balance": 100,
  "receiver_balance": 100
}

Возвращаются обновлённые балансы отправителя и получателя.

Создание заказа

Метод создаёт заказ и резервирует деньги пользователя для его оплаты.

Пример запроса:

curl --request POST \
  --url http://localhost:8080/api/v1/order/create \
  --header 'Content-Type: application/json' \
  --data '{
  "order_id": 1,
  "account_id": 1,
  "service_id": 1,
  "amount": 100
}'

Пример ответа:

{
  "order": {
    "order_id": 1,
    "account_id": 1,
    "service_id": 1,
    "amount": 100,
    "is_paid": false,
    "is_cancelled": false,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "balance": {
    "balance": 100
  }
}

Возвращается созданный заказ и обновлённый баланс пользователя.

Оплата заказа

Метод списывает зарезервированные деньги и помечает заказ как оплаченный.

Пример запроса:

curl --request POST \
  --url http://localhost:8080/api/v1/order/pay \
  --header 'Content-Type: application/json' \
  --data '{
  "order_id": 1,
  "account_id": 1,
  "service_id": 1,
  "amount": 100
}'

Тела ответа у этого метода нет, только http status ответа.

Отмена заказа

Метод отменяет заказ и возвращает зарезервированные деньги пользователю.

Пример запроса:

curl --request POST \
  --url http://localhost:8080/api/v1/order/cancel \
  --header 'Content-Type: application/json' \
  --data '{
  "order_id": 1,
  "account_id": 1,
  "service_id": 1,
  "amount": 100
}'

Пример ответа:

{
  "balance": 100
}

Метод возвращает обновлённый баланс пользователя.

Получить транзакции пользователя

Метод возвращает транзакции, в которых деньги не только поступали на счёт пользователя, но и списывались.

Метод поддерживает пагинацию и сортировку. Параметры пагинации и сортировки передаются в query string.

• 0 <= limit <= 100, default = 10
• 0 <= offset, default = 0
• sort = date | sum, по умолчанию без сортировки
• direction = asc | desc, по умолчанию asc, если sort не задан, то игнорируется

Пример запроса:

curl --request GET \
  --url http://localhost:8080/api/v1/transaction/{account_id} \
  --header 'Content-Type: application/json'

Пример ответа:

{
  "transacions": [
    {
      "transaction_id": 1,
      "type": "enrollment",
      "sender_id": 1,
      "receiver_id": 1,
      "amount": 100,
      "description": "Awesome description",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "range": {
    "limit": 10,
    "offset": 0,
    "count": 1000
  }
}

count - число всех транзакций пользователя.

sender_id и receiver_id могут совпадать, тогда это значит, что пользователь не переводил деньги другому пользователю, а использовал остальные возможности потратить или получить деньги :).

Получить ссылку на отчёт для бухгалтерии

Пример запроса:

curl --request POST \
  --url http://localhost:8080/api/v1/report/link \
  --header 'Content-Type: application/json' \
  --data '{
  "month": 10,
  "year": 2022
}'

Пример ответа:

{
  "link": "http://localhost:8080/api/v1/report/download?key=2022-10"
}

query parameter key - это строка, в которой закодированы месяц и год в формате год-месяц.

Скачать отчёт для бухгалтерии

Пример запроса:

curl --request GET \
  --url http://localhost:8080/api/v1/report/download?key=2022-10

Пример ответа:

service_id,amount
1,2
2,40