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

https://github.com/denissonpereira/file-storage-api-spring

O projeto é uma aplicação em java desenvolvida utilizando o framework Spring Boot para oferecer uma API de armazenamento de arquivos. Essa API permite que os usuários enviem, baixem e listem arquivos de um diretório específico no servidor.
https://github.com/denissonpereira/file-storage-api-spring

java java-17 java-maven-ecs java-springboot maven spring-boot spring-web

Last synced: 2 months ago
JSON representation

O projeto é uma aplicação em java desenvolvida utilizando o framework Spring Boot para oferecer uma API de armazenamento de arquivos. Essa API permite que os usuários enviem, baixem e listem arquivos de um diretório específico no servidor.

Awesome Lists containing this project

README

        

![Web 1](./public/images/post.png)


Primary Language
Open Issues
Contributors
Last Commit
Stars

# 📑 Sobre o projeto

O projeto é uma aplicação em **java** desenvolvida utilizando o framework **Spring Boot** para oferecer uma **API** de armazenamento de arquivos. Essa **API** permite que os usuários *enviem*, *baixem* e *listem* arquivos de um diretório específico no servidor. A estrutura do projeto foi organizada de acordo com as práticas recomendadas do **Spring Boot**, incluindo a separação de classes em diferentes pacotes. A funcionalidade principal da **API** inclui o **upload de arquivos**, a **geração de links para download** e a **listagem dos arquivos disponíveis**. Com isso, o projeto proporciona uma solução eficiente e escalável para gerenciar o armazenamento e o acesso a arquivos em um ambiente de aplicação *web*.

## 📚 Stack Tecnológica

Computador iuriCode

[![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white)](https://www.java.com/)
[![Spring](https://img.shields.io/badge/spring-%236DB33F.svg?style=for-the-badge&logo=spring&logoColor=white)](https://spring.io/)

# 🚀 Como executar o projeto 🚀

## ⬇️ Clonar repositório git

```
git clone https://github.com/DenissonPereira/file-storage-api-spring
```

## 👷 Construir o projeto

```
./mvnw clean package
```

## ✨ Tudo pronto! ✨

Para testar o projeto, após iniciar a aplicação, procure um arquivo e digite no terminal:

```
curl -X POST -F "file=@(nome do arquivo sem parênteses)" http://localhost:8080/api/files/upload
```

Após isso, acesse a pasta do projeto e localize a pasta de uploads. Você verá que o arquivo estará lá dentro. Outra maneira de visualizar o arquivo é usando o caminho "/list". Para isso, digite no seu navegador o seguinte endereço:

```
http://localhost:8080/api/files/list
```

# 📸 Visuals and Screenshots

Dê uma espiada no nosso projeto em funcionamento e esclareça todas as suas dúvidas sobre como executá-lo!

## 🏂 Aplicação em ação
![Web 1](./public/images//upload.gif)

## 📺 Editor de código

Neste projeto, foi utilizado o Visual Studio Code como editor de código.

[![Visual Studio Code](https://img.shields.io/badge/Visual%20Studio%20Code-0078d7.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white)](https://code.visualstudio.com/)

# 🚨 Aguarde! Ainda não terminou!

>Este projeto está atualmente em desenvolvimento, e está sujeito a futuras atualizações e melhorias conforme evolui. Estamos trabalhando para torná-lo ainda mais robusto e funcional ao longo do tempo. Agradecemos sua paciência e interesse nesta fase inicial.

>Além disso, gostaríamos de ressaltar que este projeto é aberto a contribuições de qualquer pessoa interessada em colaborar. Se você tem ideias, sugestões ou melhorias para oferecer, sinta-se à vontade para participar do desenvolvimento do projeto. Juntos, podemos criar algo incrível e beneficiar a comunidade de forma colaborativa.

## 📜 Licença

[![NPM](https://img.shields.io/npm/l/react)](https://github.com/DenissonPereira/file-storage-api-spring/blob/main/LICENSE)

## ✏️ Autor

Denisson Pereira Santos