github.com/seosoojin/caseencodingapigo

EncodedApi

Instructions

go run main.go

• Description: Starts the server

go test -v ./.../

• Execute all the tests recursively if you do on the project root

go test

• Execute the tests files in the folder that you're doing the command

Design Pattern

• Clean Ach pattern

/upload

• Description: Upload an image to a temp dir file using multipart/form-data then return the path for this file
• Curl to test:

  curl    --request POST
          --url http://192.168.0.57:3030/upload   
          -H 'Content-Type: multipart/form-data'   
          -H 'boundary=---011000010111000001101001' 
          --form 'file=@./assets/raw/test.bmp'
  

/write-message-on-image

• Description: Receives a message and a file path via POST of a JSON then encodes the message in the given file and return the new path
• Curl to test:

  curl    --request POST 
          --url http://localhost:3030/write-message-on-image 
          --header 'Content-Type: application/json' 
          --data '{
                     "path": "./assets/raw/test.bmp",
                     "phrase": "test"
                  }'
  

/get-image

• Description: Receives a encoded image name via GET then return the readable buffer for this image (utf-8 encoded)
• Curl to test:

  curl    --request GET 
          --url http://localhost:3030/get-image/test-encoded.bmp 
          --output ./assets/encoded/test.bmp
  

/decode-message-from-image

• Description: Receives a path to an encoded image, decode the message in this file and return the message
• Curl to test:

  curl    --request GET 
          --url http://localhost:3030/decode-message-from-image/test-encoded.bmp