Система управления банковскими картами

Это Spring Boot REST API для работы с банковскими картами. Проект собран на Maven и запускается в Docker-контейнерах (приложение + PostgreSQL + pgAdmin).

---

Содержание

1. Предварительные требования
2. Структура проекта
3. Генерация OpenAPI спецификации
4. Быстрый старт с Docker Compose
5. Локальный запуск без Docker (профиль dev)
6. Документация API
7. Уже созданные пользователи

---

Предварительные требования

• Установленный Docker
• Установленный Docker Compose
• (При локальном запуске) Java 17+ и Maven 3.6+

---

Структура проекта

Bank_REST
├── .gitignore
├── Dockerfile
├── docker-compose.yml
├── pom.xml
├── README.md
├── docs/
│   └── openapi.yaml
└── src/
    ├── main/
    │   ├── java/com/example/bankcards/… 
    │   └── resources/
    │       ├── application.yml
    │       └── application-dev.yml
    └── test/
        └── java/…

---

Быстрый старт с Docker Compose

1. Клонировать репозиторий и перейти в директорию проекта

   git clone <URL_репозитория>
   cd Bank_REST

2. Собрать образы и запустить контейнеры

   docker-compose up --build

3. Проверить сервисы

   • API: http://localhost:8060
   • pgAdmin: http://localhost:5433
     — логин: [email protected], пароль: admin

4. Удалить все образы и контейнер

    docker-compose down --rmi all -v

Состав контейнеров

Сервис	Образ	Порт (хост → контейнер)	Описание
postgres	postgres:16	5432 → 5432	PostgreSQL с БД BankRest
pgadmin	dpage/pgadmin4	5433 → 80	Веб-интерфейс для управления PostgreSQL
app	bank-rest:latest	8060 → 8060	Spring Boot приложение

---

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

1. Убедитесь, что установлены Java 17+ и Maven 3.6+ (или используйте Maven Wrapper).

2. В каталоге проекта выполните:

   # на Unix/macOS
   ./mvnw clean package
   ./mvnw spring-boot:run -Dspring-boot.run.profiles=dev
   
   # на Windows PowerShell
   .\mvnw.cmd clean package
   .\mvnw.cmd spring-boot:run -Dspring-boot.run.profiles=dev

3. Перейдите в браузере по адресу:
   http://localhost:8060

---

Генерация OpenAPI спецификации

Чтобы сгенерировать файл docs/openapi.yaml, выполните в корне проекта:

# при наличии глобального Maven
mvn verify

# или с Maven Wrapper
./mvnw verify

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

• OpenAPI (YAML): docs/openapi.yaml
• Swagger UI: http://localhost:8060/swagger-ui.html

Уже созданные пользователи

По дефолту уже созданы 2 пользователя: Админ и Обычный пользователь.

• Admin
  • Логин: admin
  • Пароль: admin
• User:
  • Логин: user
  • Пароль: user

---