Start with Blueprints and MethodViews

Modularizing Our Project:

To keep our project simple and usable, we employ modularity, dividing functionality across files and packages. We will now create a separate 'resources' folder for all our future endpoint files. Within this folder, we will create four files: team.py, player.py, club.py, and user.py.

Setting Up Blueprints:

In team.py, we begin by setting up our Blueprint corresponding to our model:

python
Copier le code
9
1
2
3
4
5
6
from flask.views import MethodView
from flask_smorest import Blueprint
from db import db

# First, we create our Blueprint for the team model
blp = Blueprint("teams", __name__, description="Operations on teams")

We will do the same for each subsequent model. The first argument names our blueprint, the second indicates in which module our blueprint is identified, and the last argument, the description, will be seen in our Swagger documentation.

Defining Our Class-Based Views:

Using Flask's MethodView, we define class-based views to handle different HTTP methods:

python
Copier le code
99
1
2
3
4
5
6
7
8
9
10
11
12
13
@blp.route("/teams/<string:team_id>")
class Team(MethodView):
    def get(self, team_id):
        # Retrieve a single team or delete a team
    def delete(self, team_id):
        # Delete the team

@blp.route("/teams/")
class TeamList(MethodView):
    def get(self):
        # Return a list of teams
    def post(self):
        # Create a new team

This structure neatly encapsulates the HTTP methods for the Team model. The dynamic URL responds to either fetching information about a single team or deleting it, while the second URL handles listing teams or creating a new one.

Repeating the Structure for Other Models:

We follow the same structure according to the needs and logic of our application for models like Club and Player.

python
Copier le code
99
1
2
3
4
5
6
7
8
9
10
from flask.views import MethodView
from flask_smorest import Blueprint
from db import db

blp = Blueprint("clubs", __name__, description="Operations on clubs")

@blp.route("/club/<string:club_id>")
class Club(MethodView):
    def get(self, club_id):
        # Return information about this club

Imagine we do not require any more functionality for the club model because we are creating a separate service for one team. The only thing we do is return information about this club.

Registering Our Blueprints:

In addition to defining our views, we must register our blueprints for each model:

python
Copier le code
9
1
2
3
4
5
6
7
8
9
from resources.team import blp as TeamBlueprint
from resources.club import blp as ClubBlueprint
from resources.player import blp as PlayerBlueprint

api = Api(app)

api.register_blueprint(TeamBlueprint)
api.register_blueprint(ClubBlueprint)
api.register_blueprint(PlayerBlueprint)

In app.py, after initializing our API, we register our blueprints, which integrate the defined endpoints into the application.