Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/subhashchandra-birajdar/uploadfile-image
File Storage and Retrieval API is a Spring Boot application designed to facilitate file management through a RESTful API. This project provides a comprehensive solution for storing, retrieving, and downloading files both from a database and a file system.
https://github.com/subhashchandra-birajdar/uploadfile-image
jpa-hibernate logging multipart-formdata multipart-uploads mysql-database postgresql slf4j-loggers spring-boot
Last synced: 28 days ago
JSON representation
File Storage and Retrieval API is a Spring Boot application designed to facilitate file management through a RESTful API. This project provides a comprehensive solution for storing, retrieving, and downloading files both from a database and a file system.
- Host: GitHub
- URL: https://github.com/subhashchandra-birajdar/uploadfile-image
- Owner: Subhashchandra-Birajdar
- Created: 2024-08-21T03:07:53.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-08-21T04:07:59.000Z (4 months ago)
- Last Synced: 2024-10-16T19:26:10.801Z (3 months ago)
- Topics: jpa-hibernate, logging, multipart-formdata, multipart-uploads, mysql-database, postgresql, slf4j-loggers, spring-boot
- Language: Java
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project Title - File Storage and Retrieval API
## Overview
This project is a Spring Boot application that provides a RESTful API for storing, retrieving, and managing files.
It supports storing files in both a database and the file system. The API includes endpoints for uploading files, retrieving files, and downloading files from the file system.
## Features
- Upload files to the database and file system.
- Retrieve all files with metadata (name, type, and access URL).
- Download files by name from the file system.
- Supports cross-origin requests.
## Technologies Used
- **Java 17**
- **Spring Boot**
- **Spring Data JPA**
- **Hibernate**
- **MySQL or PostgreSQL**
- **Maven**
- **Lombok**
- **SLF4J** for logging
## Getting Started
### Prerequisites
- **Java 17** or later installed
- **Maven** installed
- **MySQL** or **PostgreSQL** database setup
### Setup Instructions
1. **Clone the repository:**
```bash
git clone https://github.com/Subhashchandra-Birajdar/UploadFile-image.git
cd UploadFile-image
2. **Configure the database:**
Open the src/main/resources/application.properties (or application.yml) file and configure your database connection.
properties
```
spring.datasource.url=jdbc:postgresql://localhost:5432/your-database-name
spring.datasource.username=your-username
spring.datasource.password=your-password
spring.jpa.hibernate.ddl-auto=update
```
# File storage location
file.storage.path=C:\\path\\to\\your\\file\\storage\\directory\\
# Start the application:
The application will start on http://localhost:8080
# API Endpoints
### Upload File
- **URL:** `/api/uploadFilesIntoDB`
- **Method:** `POST`
- **Description:** Upload a file to the database and file system.
- **Request:**
- `file` (multipart/form-data): The file to be uploaded.
- **Response:**
- `200 OK` with a success message.
#### Example in Screenshot:
### Get All Files With Image Response
- **URL:** `/api/files`
- **Method:** `GET`
- **Description:** Retrieve a list of all files with their metadata.
- **Response:**
- `200 OK` with a list of files (name, type, URL).
#### Example in Screenshot:
### Download File from File System
- **URL:** `/api/getFilesFromFileSystem/{fileName}`
- **Method:** `GET`
- **Description:** Download a file from the file system by its name.
- **Path Parameter:**
- `fileName`: The name of the file to download.
- **Response:**
- `200 OK` with the file's binary data.
#### Example in Screenshot:
## API Reference
#### Upload File
```http
POST /api/uploadFilesIntoDB
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| 'file' | `multipart/form-data` | Required. The file to be uploaded. |
#### Get all images
```http
GET /api/files
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| 'none' | `string` | **Required**.Retrieves a list of all files with metadata. |
#### Get image by name
```http
GET /api/getFilesFromFileSystem/{fileName}
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `id` | `string` | **Required**. image of name to fetch |
## Project Structure
- **`src/main/java/com/jts/entity/Files.java`:** The entity class representing the files stored in the database.
- **`src/main/java/com/jts/repository/FileRepository.java`:** The repository interface for accessing file data.
- **`src/main/java/com/jts/service/FilesService.java`:** The service layer handling file operations.
- **`src/main/java/com/jts/controller/FilesController.java`:** The REST controller exposing the API endpoints.
## Logging
This project uses **SLF4J** with **Logback** for logging. Logs are written to the console during application execution.
The `FilesController` and `FilesService` classes include log statements to track the flow of operations.
## Contributing
If you'd like to contribute to this project, feel free to fork the repository and submit a pull request. Issues and feature requests are also welcome!