API Upload de Imagens

Essa aplicação foi desenvolvida exclusivamente para o upload e visualização de imagens. Através dessa API você consegue fazer upload de imagens, visualiza-las e excluí-las.

Foi feito com muito entusiasmo e carinho :)

STACK PRINCIPAL: Javascript, NodeJS, Express, MongoDB, Mongoose & Padrões REST

O QUE FOI UTILIZADO E ABSORVIDO DURANTE O PROJETO

• Criação e Consumo de API's
• Padrões REST
• Verbos HTTPS
• Status Code
• Endpoints Amigáveis
• Params, Querys e afins
• Upload de Imagens com Multer
• Criptografias & Hashs com Bcrypt
• Padronização de Cógico com ESlint, Prettier e EditorConfig
• Banco de Dados não Relacional *MongoDB, utilizando Mongoose
• "Travando" Requisições pra API com CORS
• Variáveis de Ambiente com DotEnv
• Validações com YUP
• Testando Requisição pra API com Insominia
• Estrutura MVC
• Gitflow e Commits Semanticos

GUIA RÁPIDO DE INSTALAÇÃO

1 - Dependências Iniciais

Antes de qualquer coisa, você precisa ter instaldo o NPM & Node + Git. Para Instalar o siga o passo a passo de cada link listado abaixo:

• NPM & Node
• Git
• Yarn

2 - Base de Dados

Será necessário gerar uma string de conexão com o banco. Para tal crie uma conta no atlas (grátis) e gere essa string. Você pode criar sua conta Clicando aqui.

OBS.: Caso tenha duvidas, você pode seguir este tutorial aqui

Tendo gerado a string, procure pelo arquivo .env.example e siga o passo a passo abaixo:

• colo a string no lugar indicado dentro do arquivo. Deverá ficar algo como MONGO_URL=string-que-vc-criou
• renomeie o arquivo para .env

3 - Rodando na Sua Máquina

Considerando que você executou as etapas acima com êxito, abra o seu terminal e rode os seguintes comandos em suas respectivas ordens:

• git clone https://github.com/raissaqueiroz/upload-api.git
• cd upload-api
• yarn add
• yarn start or yarn dev

Pronto! a API estará rodando na porta 3333. Caso você deseje alterar para outra porta, basta adicionar ao aquivo .env do projeto como no exemplo a seguir: PORT=3333.

Edpoints

POST /uploads:
Método para fazer upload de imagem. Você deve enviar no corpo da requisição um campo "file" contendo o arquivo.

GET /uploads:
Método para Listar Uploads Realizados Nessa Ferramenta. Ele retorna a url do arquivo, nome original e tamanho.

DELETE /uploads/:id:
Método para Deletar um Upload. É necessário enviar o ID dele no lugar de :id na URL