Building blocks for REST APIs for Flask
Project description
Building blocks for REST APIs for Flask.
Usage
Create a SQLAlchemy model and a marshmallow schema, then:
from flask_resty import Api, GenericModelView
from . import app, models, schemas
class WidgetViewBase(GenericModelView):
model = models.Widget
schema = models.WidgetSchema()
class WidgetListView(WidgetViewBase):
def get(self):
return self.list()
def post(self):
return self.create()
class WidgetView(WidgetViewBase):
def get(self, id):
return self.retrieve(id)
def patch(self, id):
return self.update(id, partial=True)
def delete(self, id):
return self.destroy(id)
api = Api(app, '/api')
api.add_resource('/widgets', WidgetListView, WidgetView)
By default, models are expected to have been created using Flask-SQLAlchemy.
from flask_sqlalchemy import SQLAlchemy
from sqlalchemy import Column, String
from . import app
db = SQLAlchemy(app)
class Widget(db.Model):
id = Column(String, primary_key=True)
name = Column(String, nullable=False)
color = Column(String, nullable=False)
Schemas can be standard marshmallow Schema instances or marshmallow-sqlalchemy TableSchema instances. They should not be ModelSchema instances.
from marshmallow_sqlalchemy import TableSchema
from . import models
class WidgetSchema(TableSchema):
class Meta:
table = models.Widget.__table__
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Flask-RESTy-0.20.12.tar.gz
(19.7 kB
view hashes)
Built Distribution
Close
Hashes for Flask_RESTy-0.20.12-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9121c083ca4334ed7b973847b80ee134ea7bbc110b5d5457968638ee69865249 |
|
MD5 | 0f9ba10fcdbcf93e6b17f2d7bb3244e2 |
|
BLAKE2b-256 | 53f4e4c1283fe87e58c6b7b6256a193f1e2e76b4a53728ac6ff4685420539ca9 |