flask-journey 0.1.1

The route decorator

api/users/schemas.py

These are regular marshmallow type schemas

from marshmallow import Schema, fields, validate

class QuerySchema(Schema):
    first_name = fields.String(required=False)
    last_name = fields.String(required=False)


class UserSchema(Schema):
    id = fields.Integer(required=True)
    first_name = fields.String(required=True)
    last_name = fields.String(required=True)
    user_name = fields.String(required=True)

api/users/views.py

The flask_journey.route decorator is used with standard Flask blueprints and enables easy (de)serialization and validation with the help of the Marshmallow library.

from flask import Blueprint
from flask_journey import route
from db import create_user, get_user

from .schema import UserSchema

bp = Blueprint('users', __name__)

@route(bp, '/', methods=['GET'], query_schema=QuerySchema(strict=True), marshal_with=UserSchema(many=True))
def get_many(__query=None):
    return get_users(**__query['data'])


@route(bp, '/', methods=['POST'], body_schema=UserSchema(strict=True), marshal_with=UserSchema())
def create(__body=None):
    return create_user(**__body['data'])

Blueprint / Route management

This component of Flask-Journey is primarily for larger applications using factories, but works in any type of Flask application.

api/bundles.py

from flask_journey import BlueprintBundle
from .users import bp as users_bp
from .groups import bp as groups_bp

v1 = BlueprintBundle(path='/api/v1')
v1.attach_bp(users_bp, description='Users API')
v1.attach_bp(groups_bp)

api/__init__.py

from flask import Flask
from flask_journey import Journey

from .bundles import v1

app = Flask(__name__)

journey = Journey()
journey.attach_bundle(v1)

journey.init_app(app)

print(journey.routes_simple)