Git Product home page Git Product logo

find_store's Introduction

Find_Store

This is a REST API developed with Flask, Flask-RESTful, FLask-JWT-Extended and Flask-SQLAlchemy.


It is now deployed on Heroku

Overview

An unanthenticated user can do the following:

  1. Get all the store name.
  2. Get the names of every item in one store

An authenticated user can do the following:

  1. Create, delete, and access one's own store
  2. Create, update, delete, and access an item in one's own store
  3. Get the information of all items in one's own store

All Endpoints

  • /register
    • POST register a new users {username, password}
  • /login
    • POST Login {username, password}
  • /logout
    • POST logout
  • /stores
    • GET get a list of current existing stores
  • /store/string:name
    • GET get the store information
    • POST create a new store
    • DELETE delete a store
  • /string:name/items
    • GET a list of items inside the specific store
  • /item/string:name
    • GET get an item information
    • POST create an new item
    • PUT update the existing item
    • DELETE delete an item
    • Input format: {float:price, string:store_name}
  • /user/int:user_id
    • GET access an user by its id
    • Delete delete an user

Sample JSON Format

User

{  
    "id": 1, 
    "username": "Jacky",
    "stores": [
        "Burgers","McDonalds
        ]
}

Store

{
    "id": 1,
    "name": "Burgers",
    "items": [
        {
            "id": 1,
            "name": "chicken",
            "price": 2.35
        }
    ],
    "owner": "Tim"
}

Item

{
    "id": 1,
    "name": "chicken",
    "price": 2.35
}

find_store's People

Contributors

jackyxu-cool 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.