An open API service indexing awesome lists of open source software.

https://github.com/jf17/simple-plm

Simple PLM
https://github.com/jf17/simple-plm

example java-17 maven plm spring-boot

Last synced: about 2 months ago
JSON representation

Simple PLM

Awesome Lists containing this project

README

        

# Простой PLM Сервис на Spring Boot

Этот REST сервис написан на Spring Boot и предназначен для получения данных из базы данных PostgreSQL в формате JSON-массива. Проект использует Flyway для управления миграциями базы данных.

## Особенности

1. **REST API**: Сервис предоставляет GET запрос по адресу `{host}:{port}/plmData`, который возвращает данные в формате JSON-массива.
2. **База Данных PostgreSQL**: Данные берутся из локальной базы данных PostgreSQL.
3. **Flyway для Миграций**: Используется Flyway для управления миграциями базы данных, что упрощает управление схемами базы данных.
4. **Docker Compose**: Проект можно запустить через `docker-compose.dev.yml`, что обеспечивает изолированное окружение для разработки.

## Установка и Запуск

1. **Клонирование Репозитория**:
```sh
git clone https://github.com/jf17/simple-plm.git
```
```sh
cd simple-plm
```

2. **Сборка проекта**:
```sh
mvn clean package
```

3. **Запуск Docker контейнеров**:
```sh
docker-compose -f docker-compose.dev.yml up
```

4. **Доступ к сервису**: После запуска, вы можете получить данные через GET запрос по адресу `http://localhost:8080/plmData`.

## Использование

После запуска контейнеров, вы можете отправить GET запрос на сервер:

```sh
curl http://localhost:8080/plmData
```

В ответ вы получите данные в формате JSON-массива.
## Миграция БД

Миграции базы данных управляются с помощью Flyway. Файлы миграций находятся в директории `src/main/resources/db/migration`.

## Технологии

- **Spring Boot**: Основа для создания REST сервиса.
- **PostgreSQL**: Используется в качестве СУБД.
- **Flyway**: Для управления миграциями базы данных.
- **Docker и Docker Compose**: Для изолированного запуска приложения и базы данных.