This pattern provides functions to easily create REST interfaces to create and edit the content of database tables.

All you need is the database table object, which was created during its registration by the usage of the GwDatabasePattern from the groundwork-database package.


The following example creates a database and a related model is created by the help of the GwDatabasePattern. To get the needed REST views to add and manipulate our database, we only need to add one line, which is provided by the GwWebDbRestPattern.:

from sqlalchemy import Column, Integer, String
from groundwork_web.patterns import GwWebDbRestPattern
from groundwork_database.patterns import GwDatabasePattern

class MyPlugin(GwWebDbRestPattern, GwDatabasePattern):
    def __init__(self, *args, **kwargs): = self.__class__.__name__
        super().__init__(*args, **kwargs)
        self.db = None

    def activate(self):
        """ Activation routine for our plugin """
        # Set up database
        self.db ="My_Database")

        # Get and register own database model
        MyUserTable = self.get_user_table(self.db)

        # Register model for new REST views, self.db.session)

    def get_user_table(database):
        Helper function, which sets our database as base class
        and returns our model class
        class MyUserTable(database):
            id = Column(Integer, primary_key=True)
            name = Column(String(255))

        return MyUserTable

Technical background

groundwork-web uses the Flask extension Flask-Restless to provide this functionality.

The used Flask-Restlessd object is available under and can be used to implement or activate each documented functionality for Flask-Restless.