paliari/upload-service repository overview

⁠Upload microservice

A lightweight upload microservice

⁠Environments:

⁠BASE_URL

Your hosting will be concatenated to the top of the directory to access the files.

⁠SECRET_KEY

Token for upload authentication, if not informed upload will be public.

In request send header Secret-Key

⁠SECRET_JWT

Secret key for JWT encryptor

⁠Volumes

⁠/storage

Volume used to save files

⁠Run with Docker

.env

BASE_URL=http://localhost:3000
SECRET_KEY=123
SECRET_JWT=my-secret

docker-compose.yml

version: '3.7'

services:
  app:
    image: paliari/upload-service
    ports:
      - 3000:3000
    volumes:
      - storage:/storage
    env_file: .env

volumes:
  storage:

⁠HTTP API

⁠GET /health

Route for check health

Content-Type: application/json

• Response 200 (application/json)

    {
      "version": "1.0.0",
      "applicationName": "Upload Service"
    }
  

  Copy

⁠GET /jwt

Route for get a jwt token to authenticate upload. Send this token in Authorization header.

Content-Type: application/json

• Request

Headers

• Response 200 (application/json)

    {
      "token": "jwt.example.token"
    }
  

  Copy

⁠POST /

Route for file uploads, if authenticated, send JWT token in Authorization header

Content-Type: multipart/form-data

• Request

Attributes

Headers

• Response 201 (application/json)

    {
      "url": "http://your-base-url.com/storage/2019/12/03/123e4567-e89b-12d3-a456-426655440000.jpeg"
    }
  

  Copy

⁠Development

⁠Define environments

cp .env.example .env

⁠Run tests

yarn docker:test

⁠Start development server

docker-compose up