Professional Web API with Flask

1. Introduction to the Course

Dive into the world of web APIs with Flask, starting with the basics. You'll learn what APIs and REST APIs are, how to set up your project, configure your environment, and establish a GitHub SSH connection. This foundational knowledge will set you up for success.

Course Outline

About API

About REST API

Project Description

Project Initialization

Environment Configuration and Dependency Management

Establish SSH Connection to GitHub

2. Database and Models

Explore the core of database handling with SQLAlchemy. You'll learn to create robust models and understand many-to-one, one-to-one, and many-to-many relationships. This section empowers you with the skills to structure complex databases for real-world applications.

SQLAlchemy Set Up

Create Models

Many-to-One Relationship

One-to-One Relationship

Many-to-Many Relationship

3. Flask-Smorest and Schemas

Unveil the power of Flask-Smorest and Marshmallow for managing web APIs and data serialization. You'll delve into JSON, schema handling, and the intricacies of data representation and validation, paving the way for advanced API development.

Introduction to Flask-Smorest

Introduction to Marshmallow

JSON Explanation

Schema Handling with Marshmallow

4. Endpoints with Blueprints and MethodView

Master the art of creating and managing endpoints with Flask's Blueprints and MethodView. From setting up your first endpoints to exploring Flask-Migration and SQLite Studio, and utilizing tools like Postman and Insomnia, you'll craft scalable and maintainable web architectures.

Blueprints and MethodView Overview

Start with Blueprints and MethodViews

First Endpoint, Flask-Migration and SQLite Studio

Postman and Insomnia

Team Endpoints

User and Player Endpoints

Swagger UI

5. Authentication with JWT

Secure your web APIs with JWT authentication. Learn to set up Flask-JWT-Extended, handle user registration, login, and logout processes, and implement permissions and security measures. By the end of this section, you'll be adept at protecting and testing your endpoints.

What is JWT?

Flask-JWT-Extended Set Up

Testing New Endpoints

6. Deployment

Prepare your Flask project for deployment. This final leap covers the essentials: creating a requirements.txt, code formatting with Black and Flake8, and documenting your project with a README.md. You'll also master Git for version control and branch merging, readying you for a seamless project launch.

Enhancing Your App

Last Git Push

Flask-JWT-Extended Set Up

To integrate the authentication feature into our website, we will use the Flask-JWT-Extended library. First, let's install it by running the following command:

Code Setup and Configuration

Next, in the app.py file, we import JWTManager from the flask_jwt_extended library:

We then add another configuration parameter within our create_app() function:

Just as we secured our SECRET_KEY in the .env file, we will also hide the JWT key. It's best to use a random set of values for greater security, similar to how we generated the SECRET_KEY.

Initialization

After adding the necessary information to the .env and .env.sample files, we initialize the jwt variable using the JWTManager and pass our app to it:

In the next chapter, we will write an endpoint for user registration.

Everything was clear?

Section 5. Chapter 2

Course Content

Professional Web API with Flask

1. Introduction to the Course

Course Outline About API About REST API Project Description Project Initialization Environment Configuration and Dependency Management Establish SSH Connection to GitHub

2. Database and Models

SQLAlchemy Set Up Create Models Many-to-One Relationship One-to-One Relationship Many-to-Many Relationship

3. Flask-Smorest and Schemas

Introduction to Flask-Smorest Introduction to Marshmallow JSON Explanation Schema Handling with Marshmallow

4. Endpoints with Blueprints and MethodView

Blueprints and MethodView Overview Start with Blueprints and MethodViews First Endpoint, Flask-Migration and SQLite Studio Postman and Insomnia Team Endpoints User and Player Endpoints Swagger UI

5. Authentication with JWT

What is JWT?Flask-JWT-Extended Set Up User Registration Login Endpoint JWT Required Permissions Logout Endpoint Testing New Endpoints

6. Deployment

Enhancing Your App Last Git Push

Professional Web API with Flask

Flask-JWT-Extended Set Up

To integrate the authentication feature into our website, we will use the Flask-JWT-Extended library. First, let's install it by running the following command:

Code Setup and Configuration

Next, in the app.py file, we import JWTManager from the flask_jwt_extended library:

We then add another configuration parameter within our create_app() function:

Just as we secured our SECRET_KEY in the .env file, we will also hide the JWT key. It's best to use a random set of values for greater security, similar to how we generated the SECRET_KEY.

Initialization

After adding the necessary information to the .env and .env.sample files, we initialize the jwt variable using the JWTManager and pass our app to it:

In the next chapter, we will write an endpoint for user registration.

Everything was clear?

Section 5. Chapter 2