Git Product home page Git Product logo

image-processing-api's Introduction

Image Processing API

Overview

This is an API that can be used in two different ways. The first, as a simple placeholder API that allows us to place images into our frontend with the size set via url parameters. The second use case is as a library to serve properly scaled versions of our images to the frontend to reduce page load size.

Scripts

  • Install: npm install
  • Build: npm run build
  • Lint: npm run lint
  • Prettify: npm run prettify
  • Run unit tests: npm run test
  • Start server: npm run start

Endpoint

Main route

http://localhost:3000/api

This endpoint will shows the query arguments for resizing an image and available image name.

Resize image

http://localhost:3000/api/images?filename=fjord&width=200&height=200

Will scale the fjord image to 200 by 200 pixels and store the resulting image.

On subsequent calls will serve the resized image instead of resizing the original again.

Miss argument error

http://localhost:3000/api/images?filename=fjord&width=200

Missing height argument will lead to missing input error.

Invalid argument error

http://localhost:3000/api/images?filename=fjord&width=-200&height=200

The invalid input will lead to invalid argument error.

Notes

  • Images are served from assets/full. Further images can be put into that directory.
  • Image thumbs will be stored in assets/thumb and can be deleted from there to verify that in that case they will be re-created on subsequent calls to the same endpoint.

image-processing-api's People

Contributors

qianhongbo avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.