Code Monkey home page Code Monkey logo

mrgreennv / bank-rest-test Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 264 KB

RESTful API, бэкенд-сервис и модель данных для создания банковских счетов и перевода денег между ними. Взаимодействие с API осуществляется с использованием HTTP-запросов.

Java 99.74% Dockerfile 0.26%
docker-compose h2-database java junit5 liquibase lombok mockito openapi spring-boot-3 swagger

bank-rest-test's Introduction

Account Service

RESTful API для управления банковскими счетами.


Описание сервиса

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

Используемые технологии

  • Java 17
  • Spring Boot 3
  • H2 databases
  • Liquibase
  • Lombok
  • Mockito
  • JUnit
  • OpenAPI (Swagger)
  • Docker

Функциональности

  • Управление: Создание, обновление, просмотр, удаление и деактивация банковских счетов.
  • Пополнение: Пополнение баланса банковского счета.
  • Снятие: Уменьшение баланса банковского счета.
  • Перевод: Взаимодействие между банковскими счетами по средствам перевода средств между ними.

Установка и настройка для запуска

Требования

Для запуска и использования этого API вам потребуется:

  • Java (рекомендуется использовать Spring Boot)
  • Maven (для сборки проекта)
  • Браузер или инструмент для выполнения HTTP-запросов (например, Postman)
1. Клонируйте репозиторий:
git clone https://github.com/MrGreenNV/bank-rest-test.git
2. Перейдите в директорию проекта:
cd bank-rest-test
3. Соберите проект с помощью Maven:
mvn clean install
4. Запустите backend-сервис:
java -jar target/bankservice-0.0.1-SNAPSHOT.jar

Установка и настройка для запуска в Docker Compose

Требования

Для запуска и использования этого API вам потребуется:

  • Docker Compose
  • Браузер или инструмент для выполнения HTTP-запросов (например, Postman)
1. Клонируйте репозиторий:
git clone https://github.com/MrGreenNV/bank-rest-test.git
2. Перейдите в директорию проекта:
cd bank-rest-test
3. Для запуска проекта в Docker воспользуйтесь следующей командой:
docker compose up --build -d
После запуска, микросервис будет доступен по адресу: http://localhost:8181/

API-endpoints

Документация OpenAPI (Swagger) будет доступна после запуска проекта по ссылке: http://localhost:8181/swagger-ui/index.html#/


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

Сервис включает модульные тесты для проверки его функциональности. Вы можете запустить тесты с помощью сборщика Maven:

mvn test

Вклад и обратная связь

Если вы хотите внести свой вклад в развитие сервиса или обнаружили проблему, пожалуйста, создайте issue в репозитории проекта или отправьте pull request с вашими предложениями.


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

Подробную документацию проекта вы можете найти, перейдя по ссылке: https://mrgreennv.github.io/bank-rest-test

bank-rest-test's People

Contributors

mrgreennv avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.