0:27 - Intro to tutorial 1:00 - Intro to the other packages used in this tutorial (SQLAlchemy, Marshmallow, PostMan) 2:01 - Creating virtual environment (Pipenv) 3:09 - Installing dependencies 4:10 - Create main file (app.py) 5:43 - Initialize flask and run server 7:02 - Creating a basic route 7:58 - Making POST request in Postman 8:18 - Setting up database URI 9:04 - Setting up database 10:46 - Initialize database 11:00 - Initialize Marshmallow 11:23 - Creating a class for your resource(s) 16:13 - Creating a product schema (This is where we use Marshmallow) 17:13 - Initialize schema 17:56 - Another schema initialization 18:50 - Creating the database 20:04 - Creating our routes 20:15 - "Create a product" route ('/product') 23:30 - Making a POST request in Postman 24:50 - Creating "fetch all products" route 25:40 - SQLAlchemy .all() method 26:46 - Testing get all products in Postman 27:28 - Creating "get single product" route 29:29 - Creating "update a product" route 31:35 - Making a PUT request to product in Postman 32:21 - Create a delete route 33:49 - Making a DELETE request in Postman
If when running "db.create_all()" from the Python interpreter you experience "RuntimeError: Working outside of application context.", instead run the following three lines: >>> from app import app, db >>> app.app_context().push() >>> db.create_all()
Another great video thank you. If anyone gets the error "AttributeError: 'list' object has no attribute 'data'", it's because since Marshmallow v3 you don't need the .data attribute as dump returns the data directly ... def get_products(): all_products = Product.query.all() result = products_schema.dump(all_products) return jsonify(result)
Just for someone who gets stuck when they get all products, the "result" variable will be default be an array/list so you don't need the `data` you can just jsonify(result)
Hi Traversy, Thanks so much for this video. I had been reading a lot and trying to get the concept of such an API but it was confusing to me mostly because many tutorials start off by putting different things in different files and then they import different modules into each other-it's just too confusing for a beginner. So thanks to God you put everything in a single file and gave us an overview. You have no idea how that is important to me.
Thank you for presenting an example by using my favorite two tools - pipenv and vscode. They save so much time and effort. I also ALWAYS create a git repository for projects, even if they are the throwaway kind. As of this date, marshmallow is version 3.0 and the "strict" key is no longer needed or allowed.
Thanks for the video Brad. kudos. I was getting this error when sending a GET to return all the Products, To fix it I returned jsonify(result) instead of jsonify(result.data) I hope it will save someone else time =)
Thank you! I’m coming from node web backends and just tryna switch it up and start using python instead. Most tutorials were just brushing over the basics without explaining and getting straight to the point. Thank you brad, you’re THE best!
For people coming across this video in June 2021. I had a few issues using the latest versions of everything. 1. At 18 minutes the schema no longer requires strict = True. 2. At 16.30, result.data should be result.
For anyone using this now, and update to Marshmallow (from documentation): Setting the strict option on class Meta has no effect on Schema behavior. Passing strict=True or strict=False to the Schema constructor will raise a TypeError.
Quite old, some methods are not the same right now. But it's definitely a good tutorial. The strict param is not accepted right now for marshmallow (product(s)_schema) For the get_all the following lines are the new ones: all_products = Product.query.all() return products_schema.jsonify(all_products)
Thank you so much for this. As a part of an interview assignment, I was given a task to create a CRUD system and expose APIs for a table. Starting from absolutely 0 knowledge about Flask, I was able to fully develop it thanks to you. Thank you so much! Do let me know if there is some way I can buy you a couple of beers (your Paypal?)
Awesome tutorial, it clearly shows why Flask is the best framework for python API development. You can also use Flask-Restful to define your endpoints. It give you all the HTTP verbs ready, your endpoints will be called resources rather than routes. Thanks Brad for your hard work and dedication.
I was introduced to FastAPI and never want to look back! It feels like a sucessor to flask: inspired by it, but adding a lot of structure and validation with parameters and type hints.
For anyone confused about how the table name is generated, I just realized that on executing the db.create_all() command, a table with same name as the lower cased Class name gets created in SQLite database, so in this case a table named 'product' is created with the defined schema. Also, if Class name has a name like MyProduct then table would be named as my_product.
Breaking Marshmallow changes since the version used to record this tutorial. 3.0.0b7 (2018-02-03) Features: Backwards-incompatible: Schemas are always strict (#377). The strict parameter is removed. Backwards-incompatible: Schema().load and Schema().dump return data instead of a (data, errors) tuple (#598).
Thanks for a quick introduction to Flask REST API. I am working on a React/Flask application for IT Inventory system. I was looking for something quick on Flask REST API development.
I really love Flask coz it's is similar to express when it comes to build apis but I would love to watch a video with authentication added to this via Rest. Anyways your contents are making our lives in this competitive world easier. Thanks teacher
I love this; that you make real projects now days that are more "complete" and not just 'frontend', but I would like to see more front-end, please. E.g. you could explain how 'content: ""' works when people use it "before" and "after" when they do these seemingly magic stuff. How does it work? Looks like magic to me, and would like to know more about it.
Just a note: jsonify does more than the simple conversion (if I'm not mistaken), it actually does some other prep steps to make it ready to be used as a response. For a simple conversion, you can use the built in module `json` ... json_string = json.dumps(som_python_dict)
Thank you very much for this tutorial. product_schema = ProductSchema(strict=True) was throwing up an error for the flask server. So I omitted it and the program ran without any hiccups. I had to use the POSTMAN desktop app to request the API. Thank a lot again. Regards Ed
Thank you for providing such great content. However, I believe many of us would like to see this project expanded further. Right now, as great this tutorial might be, it's not suitable to use for any real-world application. Some things I would like to see are: breaking the app.py into multiple files to separate out the models and routes, using token authentication, implementing model relationships, etc. I hope you please consider. Thank you.
For anyone following this tutorial in 2021 The strict parameter was removed. Schemas are always strict. So product_schema = ProductSchema() products_schema = ProductSchema(many=True)
Is this some sort of magic? I swear I was reading flask documentation and now you post a video. Thank you so MUCH BTWBrad, what magic classes do you take,?
This was a great video that explained some elements that I hadn't quite grasped within my existing API. Covered all CRUD scenarios however I feel "Add Multiple Products" would have just finished those scenarios off.
Nice. Lots of online documentation is a bit out of date and will recommend flask-restful or flask-restplus. A better alternative is the stack you use, plus flask-classful. So easy and lightweight.
I was watching your other flask tutorial just the other day, so this video came at the perfect time. Thanks, Brad! I've even been telling my girlfriend about you.
Hi Brad, I've been following your channel for the past few months. I have learnt HTML and CSS as well as Python from your channel. I was forced to learn Java in my college as part our curriculum (which I find hard as a first time coder) and currently, we are going to make an Android app Although I find React Native to be really efficient, my professors, insist that I should make an app through Java. Can you include a crash course on Java and Android Studio. sorry if I'm asking too much. Your work is awesome as always
Nice tutorial. It is clearly the best I have seen since I began Flask API. But, one of my biggest questions I always not answered. This question is the next one: How would you structure a complete API in Flask? Have you some resource which can answer to this or any public project which can be used as example?
Good Tutorial Thanks Brad Might be something new with Marshmellow but I think that this is the correct synatax - # Init Schema product_schema = ProductSchema() products_schema = ProductSchema(many=True) I tried it with strict and it was dropping an error .. above worked.
Awesome video. could you make a small video that integrates a flask backend and a react frontend. I would like to know how the data flows between both ends. More so how to send data from the frontend and receive it in the flask backend. Please if you do get a chance make a video on it. Thank you.
On the get all products route I had to remove .data from result in order to see my products. I was getting the error, " 'list' object has no attribute 'data' ".
File "C:\Users\Engr\Documents\flask-api\traversy\app.py", line 47, in add_product name = request.json['name'] TypeError: 'NoneType' object is not subscriptable after I try to make the same post request with postman. And I got the same error with the code from github so I wrote all the code correctly. Can anyone help with this?
Thanks Brad, your RestFull video is pretty cool. I would like to learn more about Restfull and MongoDb using Tuples, if you are thinking of a tutorial so I will wait for the bell to ring !!!
Dont know why Traversy decided to create the database in the terminal makes no sense to me, instead import create_engine from sqlalchemy, then engine=create_engine(use the url Traversy uses) then db.Model.metadata.create_all(engine) and thats it ! You can add ‘if not database_exists(engine.url): db.Model.metadata etc.’ to only create database if it does not exist, that will make your program portable. There are many ways to check if a database exists but installing the sqlalchemy_utils and importing database_exists is easier
For a REST API I think it would be better to showcase the PATCH method for updating a product. There is a whole debate to be had about idempotence, but most of the time you do not want to supply the entire product in order to update a single field. Especially if the API is not consumed by a frontend, but utilized directly by an end-user to fetch and modify data.
great video, I have a question. If I give an example, I have a user table and a vehicle table user and my vehicle table are one-to-many linked. When I get my user table, the vehicle's id comes. How do I get all the values of the vehicle to be listed, not just the id?
At 26:40, would it be all right to replace the two statements: result = products_schema.dump(all_products) return jsonify(result.data) with: products_schema.jsonify(all_products) ? I'm too much of a noob to understand the difference 🙈
*marshmallow product schema's are now strict by default so the strict argument in ProductSchma() will give an error; also, "you don't need to access .data attribute, dump already returns the data." @line 60 during 26:40
name = request.json['name'] TypeError: 'NoneType' object is not subscriptable - keep getting this error and looking all over for it, but I have no idea what it means. Can anyone help?
0:27 - Intro to tutorial
1:00 - Intro to the other packages used in this tutorial (SQLAlchemy, Marshmallow, PostMan)
2:01 - Creating virtual environment (Pipenv)
3:09 - Installing dependencies
4:10 - Create main file (app.py)
5:43 - Initialize flask and run server
7:02 - Creating a basic route
7:58 - Making POST request in Postman
8:18 - Setting up database URI
9:04 - Setting up database
10:46 - Initialize database
11:00 - Initialize Marshmallow
11:23 - Creating a class for your resource(s)
16:13 - Creating a product schema (This is where we use Marshmallow)
17:13 - Initialize schema
17:56 - Another schema initialization
18:50 - Creating the database
20:04 - Creating our routes
20:15 - "Create a product" route ('/product')
23:30 - Making a POST request in Postman
24:50 - Creating "fetch all products" route
25:40 - SQLAlchemy .all() method
26:46 - Testing get all products in Postman
27:28 - Creating "get single product" route
29:29 - Creating "update a product" route
31:35 - Making a PUT request to product in Postman
32:21 - Create a delete route
33:49 - Making a DELETE request in Postman
Everything is easy if you put them in a single module, you should organise your app in a proper structure and then explain what you are doing.
If when running "db.create_all()" from the Python interpreter you experience "RuntimeError: Working outside of application context.", instead run the following three lines:
>>> from app import app, db
>>> app.app_context().push()
>>> db.create_all()
was looking for this. thanks sm
thanks!!
really thanks
instead you can ad a line of code in you app.py file "# Create all tables within the application context
with app.app_context():
db.create_all()
"
Even better, use flask shell commabd. "flask shell" this will start python shell with a flask application context ready calles
Another great video thank you.
If anyone gets the error "AttributeError: 'list' object has no attribute 'data'", it's because since Marshmallow v3 you don't need the .data attribute as dump returns the data directly ...
def get_products():
all_products = Product.query.all()
result = products_schema.dump(all_products)
return jsonify(result)
Thank you.
This channel is the gift that keeps giving.
Make sure you give back ;)
Just for someone who gets stuck when they get all products, the "result" variable will be default be an array/list so you don't need the `data` you can just jsonify(result)
Hi Traversy, Thanks so much for this video. I had been reading a lot and trying to get the concept of such an API but it was confusing to me mostly because many tutorials start off by putting different things in different files and then they import different modules into each other-it's just too confusing for a beginner. So thanks to God you put everything in a single file and gave us an overview. You have no idea how that is important to me.
Thank you for presenting an example by using my favorite two tools - pipenv and vscode. They save so much time and effort. I also ALWAYS create a git repository for projects, even if they are the throwaway kind. As of this date, marshmallow is version 3.0 and the "strict" key is no longer needed or allowed.
Thanks for the video Brad. kudos.
I was getting this error when sending a GET to return all the Products,
To fix it I returned jsonify(result) instead of jsonify(result.data)
I hope it will save someone else time
=)
Came here to find this exact problem
this solved my issue too of not finding 'data'
This was my last issue with the code. Thanks.
I was just about to comment this myself. Cheers!
You save my time, thanks
Thank you! I’m coming from node web backends and just tryna switch it up and start using python instead. Most tutorials were just brushing over the basics without explaining and getting straight to the point. Thank you brad, you’re THE best!
Still useful in 2022. Thanks so much for this tutorial. I can't believe how easy this was to implement.
For people coming across this video in June 2021. I had a few issues using the latest versions of everything.
1. At 18 minutes the schema no longer requires strict = True.
2. At 16.30, result.data should be result.
legend, thanks
For anyone using this now, and update to Marshmallow (from documentation):
Setting the strict option on class Meta has no effect on Schema behavior. Passing strict=True or strict=False to the Schema constructor will raise a TypeError.
Thanks bro.
legend, thanks
yeah i got it and removed it
Flask is ridiculously simple to work with Rest APIs. So grateful with this tutorial
Quite old, some methods are not the same right now. But it's definitely a good tutorial.
The strict param is not accepted right now for marshmallow (product(s)_schema)
For the get_all the following lines are the new ones:
all_products = Product.query.all()
return products_schema.jsonify(all_products)
Thank you so much, it saved a lot of time
Also, could you tell if dump() is depreciated?
thanks man
Thank you so much for this.
As a part of an interview assignment, I was given a task to create a CRUD system and expose APIs for a table.
Starting from absolutely 0 knowledge about Flask, I was able to fully develop it thanks to you.
Thank you so much!
Do let me know if there is some way I can buy you a couple of beers (your Paypal?)
Awesome tutorial, it clearly shows why Flask is the best framework for python API development.
You can also use Flask-Restful to define your endpoints.
It give you all the HTTP verbs ready, your endpoints will be called resources rather than routes.
Thanks Brad for your hard work and dedication.
I was introduced to FastAPI and never want to look back! It feels like a sucessor to flask: inspired by it, but adding a lot of structure and validation with parameters and type hints.
For anyone confused about how the table name is generated, I just realized that on executing the db.create_all() command, a table with same name as the lower cased Class name gets created in SQLite database, so in this case a table named 'product' is created with the defined schema. Also, if Class name has a name like MyProduct then table would be named as my_product.
Thank you Brad, i learn anything from node js, react js, and today currently learn python(flask) from you. I prefer with how you teach some thing
I would really appreciate a tutorial on how this could work with NoSQL! Great work, Brad.
Breaking Marshmallow changes since the version used to record this tutorial.
3.0.0b7 (2018-02-03)
Features:
Backwards-incompatible: Schemas are always strict (#377). The strict parameter is removed.
Backwards-incompatible: Schema().load and Schema().dump return data instead of a (data, errors) tuple (#598).
My lunch break well spent watching another Brad tutorial!
Thanks for a quick introduction to Flask REST API. I am working on a React/Flask application for IT Inventory system. I was looking for something quick on Flask REST API development.
Once again a simple and perfect demonstration, love your work! Keep it up
I am currently studying this same topic, great having Brad’s take on it.
Thanks from Japan.
Your video is very useful to me.
Thank you very much.
I really love Flask coz it's is similar to express when it comes to build apis but I would love to watch a video with authentication added to this via Rest. Anyways your contents are making our lives in this competitive world easier. Thanks teacher
Watched this late, but the information is still relevant! A life save! Thanks Brad!
I love this; that you make real projects now days that are more "complete" and not just 'frontend', but I would like to see more front-end, please. E.g. you could explain how 'content: ""' works when people use it "before" and "after" when they do these seemingly magic stuff. How does it work? Looks like magic to me, and would like to know more about it.
Ohhhh Thankssss Brad .You are the best .I am just Searching for this tutorial ......Love you man...
I m currently working on a project with the exact same tools and man I needed a video like this on
Hi, am getting an error, (TypeError: __init__() got an unexpected keyword argument 'strict') any advice
Got same errors too. I removed 'strict' and it worked.
Also getting this error, anyone know why?
@@johnnysim1985 new version release. Schemas are always strict so no need.
CzemBri ;p
@@KushChoudhary Thanks
Thanks for very nice explanation. It is explained in such a way that beginner gets confidence to go ahead without any frustration.
Just a note:
jsonify does more than the simple conversion (if I'm not mistaken), it actually does some other prep steps to make it ready to be used as a response. For a simple conversion, you can use the built in module `json` ... json_string = json.dumps(som_python_dict)
Thank you very much for this tutorial.
product_schema = ProductSchema(strict=True) was throwing up an error for the flask server. So I omitted it and the program ran without any hiccups. I had to use the POSTMAN desktop app to request the API.
Thank a lot again.
Regards Ed
This year is going to be awesome for your students first React and now this. Thanks Sir!
Outstanding, so clear and simple, thank you.
Thank you for providing such great content. However, I believe many of us would like to see this project expanded further. Right now, as great this tutorial might be, it's not suitable to use for any real-world application. Some things I would like to see are: breaking the app.py into multiple files to separate out the models and routes, using token authentication, implementing model relationships, etc. I hope you please consider. Thank you.
For anyone following this tutorial in 2021 The strict parameter was removed. Schemas are always strict.
So
product_schema = ProductSchema()
products_schema = ProductSchema(many=True)
Thanks
Hey Brad, you are a gift from the Web Dev Gods.
Is this some sort of magic?
I swear I was reading flask documentation and now you post a video. Thank you so MUCH
BTWBrad, what magic classes do you take,?
Come on, you know I can't tell you that. Nice try though :)
I was just looking into it too! Brad is in tune
me too.
This was a great video that explained some elements that I hadn't quite grasped within my existing API. Covered all CRUD scenarios however I feel "Add Multiple Products" would have just finished those scenarios off.
If you're getting an empty object for your JSON response, you need to add the 'many' option to the 'dump' method.
dump(arr_objs, many=True)
Great video. This looks so simple I wish I could find a gig doing Python and Flask everyday :)
I'm a simple man. When I see new video from Brad - put like on it
Really good video for the basics, thanks !
Thanks for sharing a little of knowledge. This makes the world a better place.
Nice. Lots of online documentation is a bit out of date and will recommend flask-restful or flask-restplus. A better alternative is the stack you use, plus flask-classful. So easy and lightweight.
Thank you for this video. Please make a video on 'Flask as Rest API and Angular as the Front end.' Thumbs up.
I was watching your other flask tutorial just the other day, so this video came at the perfect time. Thanks, Brad! I've even been telling my girlfriend about you.
Thank you from India 🇮🇳 Sikkim.
Thank you Brad, It is very good tutorial. The sample code works for me.
This is a great tutorial. Thanks for putting this up. Definitely saving this video.
Great video as ever guys. Have a nice and successful 2019 , best wishes from México to both of you!
Hi Brad, I've been following your channel for the past few months. I have learnt HTML and CSS as well as Python from your channel. I was forced to learn Java in my college as part our curriculum (which I find hard as a first time coder) and currently, we are going to make an Android app Although I find React Native to be really efficient, my professors, insist that I should make an app through Java. Can you include a crash course on Java and Android Studio. sorry if I'm asking too much. Your work is awesome as always
Thanks Brad ! Lots of Love
No problem, thanks for watching :)
Great Video man... keep the good work. It was a really really good learning. Many thanks for putting this effort and spreading useful knowledge.
I am getting error
400 Bad Request
Bad Request
Failed to decode JSON object: Expecting value: line 1 column 1 (char 0)
Great Tutorial for the Flask beginners! Thanks a lot.
Nice tutorial. It is clearly the best I have seen since I began Flask API.
But, one of my biggest questions I always not answered. This question is the next one:
How would you structure a complete API in Flask?
Have you some resource which can answer to this or any public project which can be used as example?
Thanks for the awesome vid, really easy to follow and learned so much
thank you so much sir , It's easy to use, and feels modern and natural.
Really clear tutorial, thank you very much!
Good Tutorial Thanks Brad Might be something new with Marshmellow but I think that this is the correct synatax - # Init Schema
product_schema = ProductSchema()
products_schema = ProductSchema(many=True)
I tried it with strict and it was dropping an error .. above worked.
thanks
Awesome, you're making our life easy..thanks!
Pipenv is my fav package at the moment! So awesome!
Awesome video! I have been wondering how to make a API. Thank you !
Awesome video. could you make a small video that integrates a flask backend and a react frontend. I would like to know how the data flows between both ends. More so how to send data from the frontend and receive it in the flask backend. Please if you do get a chance make a video on it. Thank you.
1. Brad uploads a video
2. Click on the video
3. Click on Like btn
4. Watch the entire vid in a single sitting
5. Repeat
Thats nice Brad, can yu make authentication on this API
I will see if I can do that
@@TraversyMedia that will be fine, and also how to deploy flask app on do with mysql db
@@TraversyMedia Authentication to this API, pleeeeease :)
Yes you can use Flask-Login and Flask-Jwt for auth.
@@TraversyMedia yes please! this is exactly what I want to learn!
No need for strict=True, now schemas are always strict!
Had a lot of issue with that then i just remove it completely and also in return just jsonfy(result)
Thank you very much sir I really appreciate your work . Which helps me alot ❤.
On the get all products route I had to remove .data from result in order to see my products. I was getting the error, " 'list' object has no attribute 'data' ".
Use return jsonify(result) instead. You don't need .data
You read my mind! Awesome! Blueprint and RESTPlus is also a good next video(s)
Very nice tutorial, thanks
File "C:\Users\Engr\Documents\flask-api\traversy\app.py", line 47, in add_product
name = request.json['name']
TypeError: 'NoneType' object is not subscriptable
after I try to make the same post request with postman. And I got the same error with the code from github so I wrote all the code correctly. Can anyone help with this?
@Isaac Neace SAME PROBLEM
Thanks man.... Always there for us 😍
This is amazing brad! Niceee!!!!!
Thanks :)
Ohhh yeah, Flask tuts. Love it.
Thanks Brad, your RestFull video is pretty cool. I would like to learn more about Restfull and MongoDb using Tuples, if you are thinking of a tutorial so I will wait for the bell to ring !!!
Brad, I'm a big fan of you. please do the full project-based course of a flask in udemy.
Dont know why Traversy decided to create the database in the terminal makes no sense to me, instead import create_engine from sqlalchemy, then engine=create_engine(use the url Traversy uses) then db.Model.metadata.create_all(engine) and thats it ! You can add ‘if not database_exists(engine.url): db.Model.metadata etc.’ to only create database if it does not exist, that will make your program portable. There are many ways to check if a database exists but installing the sqlalchemy_utils and importing database_exists is easier
Tell me more about this please, Have you any videos concerning this?
Excellent video once again Brad!!! I would be grateful if you could do a Flask React app with deployment!
For a REST API I think it would be better to showcase the PATCH method for updating a product. There is a whole debate to be had about idempotence, but most of the time you do not want to supply the entire product in order to update a single field. Especially if the API is not consumed by a frontend, but utilized directly by an end-user to fetch and modify data.
Loved it!!
Great video ,very useful.
Man! You're a life saver
If you have an empty json output after post request, Change the "Fields" to "fields" in the product schema
great video, I have a question. If I give an example, I have a user table and a vehicle table user and my vehicle table are one-to-many linked. When I get my user table, the vehicle's id comes. How do I get all the values of the vehicle to be listed, not just the id?
You are a life saver !
Wow, great tutorial! Thanks a lot!
At 26:40, would it be all right to replace the two statements:
result = products_schema.dump(all_products)
return jsonify(result.data)
with:
products_schema.jsonify(all_products)
? I'm too much of a noob to understand the difference 🙈
very informative and needed thank you
If you found an error about strict or marshmallow. Install the packages following this version:
marshmallow==3.0.0b6
marshmallow-sqlalchemy==0.15.0
*marshmallow product schema's are now strict by default so the strict argument in ProductSchma() will give an error; also, "you don't need to access .data attribute, dump already returns the data." @line 60 during 26:40
Thank you so much
Great video Brad, would like to see with MongoDB
Excellent tutorial. So far I have not figured out how to place classes in a separate file. Any suggestions on that?
just what I need :D thanks for this!
Thank you it was very help.
name = request.json['name']
TypeError: 'NoneType' object is not subscriptable - keep getting this error and looking all over for it, but I have no idea what it means. Can anyone help?
Yo - This was dope thank you!