Skip to content

RishiSD/Flask-REST-API-Heroku

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Stores REST Api

This is built with Flask, Flask-RESTful, Flask-JWT and Flask-SQLAlchemy

Deployed on Heroku https://stores-rest-api-rishi.herokuapp.com/.

Documentation

Resources

Item

Attributes

name(string): Name of the item.
price(float): Price of the item in USD.
store_id(int): Unique ID for a store.

Endpoints

GET/item/<string:name>: Get an item by passing item name.
POST/item/<string:name>: Add a new item using item name.
PUT/item/<string:name>: Add or update an item using item name.
DELETE/item/<string:name>: Delete an item using item name.
GET/items: Get a list of all the items.

Store

Attributes

name(string): Name of the store.
items(array): List of items in the store.

Endpoints

GET/store/<string:name>: Get store by passing store name.
POST/store/<string:name>: Add a new store using store name.
DELETE/store/<string:name>: Delete a store using store name.
GET/stores: Get a list of all the stores.

User

Attributes

username(string): Name of the API user.
password(string): Password of the API user.

Endpoints

POST/register: Add or Register a user to get JWT token for add, update or delete activities.

About

A Flask REST API to be deployed on Heroku

Resources

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages