Code Monkey home page Code Monkey logo

file-api-kotlin-spring's Introduction

File API

Simple API for file Upload/Download.

Functionalities

  • User can upload files and a token for this file is returned
  • User can download a file using a token with appropriate headers (some additional metadata headers are also needed).
  • User can request meta data for a single file using token
  • User can request meta data for multiple file in a single request using list of tokens

Additional Features

  • Documentation describing all the endpoints and responses. Details are here
  • Invalid request returns 400 Bad Request in response body.
  • Internal exceptions are handled, logged and returns 503 Service Unavailable

Start-up

Starting the database

docker-compose up -d

Configuration

Environment variables are set in variables.env file.

Usage

To test the app locally, add

127.0.0.1    filedb

to your /etc/hosts file

For basic auth, username is admin and password is hunter2

Start from CLI

The shell script makes it easy ./do.sh start

For API documentation go to http://localhost:6011/docs

file-api-kotlin-spring's People

Contributors

ashfaqshuvo007 avatar

Watchers

 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.