https://github.com/jordanmarcelino/spring-contact-api
Spring Boot Contact API with PostgreSQL
https://github.com/jordanmarcelino/spring-contact-api
backend-api java spring spring-boot
Last synced: 5 months ago
JSON representation
Spring Boot Contact API with PostgreSQL
- Host: GitHub
- URL: https://github.com/jordanmarcelino/spring-contact-api
- Owner: JordanMarcelino
- License: mit
- Created: 2024-11-05T11:05:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-09T08:13:16.000Z (over 1 year ago)
- Last Synced: 2025-04-08T15:52:27.335Z (about 1 year ago)
- Topics: backend-api, java, spring, spring-boot
- Language: Java
- Homepage:
- Size: 122 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spring Contact Management API
Learning creating REST API with Spring Boot and PostgreSQL.
This project is using Java version 21 and Spring Boot
version 3.3.5
## How to Run
### 1. Clone the Repository
```bash
git clone https://github.com/JordanMarcelino/spring-contact-api.git
cd spring-contact-api
```
### 2. Build and Run the Docker Images
```bash
docker compose up -d --build
```
## Usage
You can see the API Documentation at `api/openapi-spec/swagger.yaml`.
### 1. Download the Postman Collection & Environment
You can download the Postman Collection and Environment at ```postman/*.json```.
### 2. Import the Postman Collection & Environment
Open the Postman application and import the collection and environment. You can try the API with the predefined request.