Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 809 Bytes

README.md

File metadata and controls

34 lines (21 loc) · 809 Bytes

store-api

A REST API for store, implemented using Flask-RESTful, Flask-JWT, Flask-SQLAlchemy.

Installation

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

REST Principle

  • One PATH, multiple VERBS operating on same resource. Similar to object oriented programming.
  • Sigular vs Plural.

API Best Practices

  • When method is already GET, don't name any endpoint like, /getstudent

Addons

In second part of the course, we'll be incorporating a lot more.

Marshmallow

Marshmallow is accountable for replacement of reqparse. It also helped in making our codebase more managable by eleminating need of __init__ and json methods in Models.

Mailgun

Mailgun was used to send confirmation emails. It will be used in other email related tasks.