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__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.11.tar.gz
(19.3 kB
view details)
Built Distribution
File details
Details for the file Flask-RESTy-0.20.11.tar.gz.
File metadata
- Download URL: Flask-RESTy-0.20.11.tar.gz
- Upload date:
- Size: 19.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/2.7.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 268598c3005b25cf5a2766754c71518849a9e60a7c35f1601d8c2b66277272aa |
|
| MD5 | ab682b9cc0893a7f3ca6cbfa755f0d2c |
|
| BLAKE2b-256 | eb45d631ccdde6fcb41ed12fe83036fd18c33a0e1dfd91b214360514545f049d |
File details
Details for the file Flask_RESTy-0.20.11-py2.py3-none-any.whl.
File metadata
- Download URL: Flask_RESTy-0.20.11-py2.py3-none-any.whl
- Upload date:
- Size: 26.8 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/2.7.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c4db8d1d23ec48e69b91d92339e30833b7b3b80741da5f99e81c598c9554a644 |
|
| MD5 | 217826994aa8022411206fedd6b10779 |
|
| BLAKE2b-256 | 1b955c94b8cde3557f6f8c4703fa0fc29e2a6962517e94c8aeabf2d9101d1df1 |
