Skip to content

Latest commit

 

History

History
77 lines (47 loc) · 1.1 KB

README.md

File metadata and controls

77 lines (47 loc) · 1.1 KB

Image Processing API

Run Locally

Clone the project

  git clone https://github.com/DGCP3/Image-Processing-API.git

Go to the project directory

  cd Image-Processing-API

Install dependencies

  npm install

Start the server

  npm run start

For testing

  npm test

Features

  • Resize image
  • Blur/Sharp image quality
  • Convert image format type
  • Other things that shap can handle

API Reference

Image processing route

  GET /image
Parameter Type Description
filename string Required. filename of image that you want to process
width number Optional. width of processed image
height number Optional. height of processed image
format string Optional. file type of processed image

Health check

  GET /

Return 200 if server is up and running

Tech Stack

Server: Typescript, Node, Express, Sharp

Authors