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.4.tar.gz
(18.9 kB
view details)
Built Distribution
File details
Details for the file Flask-RESTy-0.20.4.tar.gz.
File metadata
- Download URL: Flask-RESTy-0.20.4.tar.gz
- Upload date:
- Size: 18.9 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 | 4c42eeae2ac3a43ae45e277f05e17df9c133d340f467ca4c459c546f3f27bfdc |
|
| MD5 | 6f68debc9c2214b90d883eda023dc17a |
|
| BLAKE2b-256 | b1728c85653880abf7c8a4d41f146a4be7123d0f603cbcb57353b4e62ef0a9dd |
File details
Details for the file Flask_RESTy-0.20.4-py2.py3-none-any.whl.
File metadata
- Download URL: Flask_RESTy-0.20.4-py2.py3-none-any.whl
- Upload date:
- Size: 26.3 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 | f2cf6ff57ecb7626c394efe96d8e64f9c49c7a9cfdf6d70f2b5fde845d01b16e |
|
| MD5 | e3ba940cf4b502f15cf158853f8cdfa0 |
|
| BLAKE2b-256 | 7f9314b36c342e8c4ae238fa2a700b3e953eda8480e2adfea7dd8c9887b844ee |
