Giter VIP home page Giter VIP logo

quick-kart-api-deploy's Introduction

Quick Kart API

This Quick Kart API interfaces with the front end of the Android application made by another contributor. To test the API, you may use curl or Postman to send requests to the end points.

Links

Original repository: https://github.com/envaleed/quick-kart

Live version: https://quickkart-api.herokuapp.com/

Libaries and Technologies

This API was developed using the Python microframework, Flask and tested using Postman and the curl command line tool. The libraries I used are as follows:

  1. Flask-SQLAlchemy to connect to the cloud Postgresql database
  2. Flask-Bcrypt to hash and salt the passwords
  3. Flask-JWT for authorization using JWT tokens
  4. Flask-Marshmallow for JSON serialization

Endpoints

Register

curl -d '{"username":"<YOUR NAME>","password":"<YOUR PASSWORD>","email":"<YOUR EMAIL>"}' -H "Content-Type: application/json" -X POST https://quickkart-api.herokuapp.com/api/registration/

Login with JWT Authentication

curl -d '{"username":"<YOUR NAME>","password":"<YOUR PASSWORD>"}' -H "Content-Type: application/json" -X POST https://quickkart-api.herokuapp.com/auth

Search for Groceries

curl -XPOST -H 'Authorization: jwt <TOKEN FROM /auth>' -H "Content-type: application/json" -d '{"keyword":"fruit"}' 'https://quickkart-api.herokuapp.com/api/search/'

Add Orders to Cart

curl -XPOST -H 'Authorization: jwt <TOKEN FROM /auth>' -H "Content-type: application/json" -d '[{"title":"Bananas","quantity":12},{"title":"Apples","quantity":10},{"title":"Oranges","quantity":20 },{"title":"Blueberries","quantity":18}]' 'https://quickkart-api.herokuapp.com/api/postorder/'

Find An Orders

curl -XGET -H "Content-type: application/json" 'https://quickkart-api.herokuapp.com/api/findorder/<id>/<title>'

Find All Orders

curl -XGET -H "Content-type: application/json" 'https://quickkart-api.herokuapp.com/api/findorders/<id>/'

quick-kart-api-deploy's People

Contributors

envaleed avatar

Watchers

 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.