Flask-Rebar
Flask-Rebar combines flask, marshmallow, and swagger for robust REST services.
Features
Request and Response Validation - Flask-Rebar relies on schemas from the popular Marshmallow package to validate incoming requests and marshal outgoing responses.
Automatic Swagger Generation - The same schemas used for validation and marshaling are used to automatically generate OpenAPI specifications (a.k.a. Swagger). This also means automatic documentation via Swagger UI.
Error Handling - Uncaught exceptions from Flask-Rebar are converted to appropriate HTTP errors.
Example
from flask import Flask
from flask_rebar import errors, Rebar
from marshmallow import fields, Schema
from my_app import database
rebar = Rebar()
# All handler URL rules will be prefixed by '/v1'
registry = rebar.create_handler_registry(prefix='/v1')
class TodoSchema(Schema):
id = fields.Integer()
complete = fields.Boolean()
description = fields.String()
# This schema will validate the incoming request's query string
class GetTodosQueryStringSchema(Schema):
complete = fields.Boolean()
# This schema will marshal the outgoing response
class GetTodosResponseSchema(Schema):
data = fields.Nested(TodoSchema, many=True)
@registry.handles(
rule='/todos',
method='GET',
query_string_schema=GetTodosQueryStringSchema(),
response_body_schema=GetTodosResponseSchema(), # for versions <= 1.7.0, use marshal_schema
)
def get_todos():
"""
This docstring will be rendered as the operation's description in
the auto-generated OpenAPI specification.
"""
# The query string has already been validated by `query_string_schema`
complete = rebar.validated_args.get('complete')
...
# Errors are converted to appropriate HTTP errors
raise errors.Forbidden()
...
# The response will be marshaled by `marshal_schema`
return {'data': []}
def create_app(name):
app = Flask(name)
rebar.init_app(app)
return app
if __name__ == '__main__':
create_app(__name__).run()For a more complete example, check out the example app at examples/todo.py. Some example requests to this example app can be found at examples/todo_output.md.
Installation
pip install flask-rebarReplacing static swagger-ui files
If you’d like to replace swagger-ui’s static files (flask_rebar/swagger_ui/static) with those of the latest release, run the following from the root of the project.
curl -L https://api.github.com/repos/swagger-api/swagger-ui/tarball | tar -xv --directory=flask_rebar/swagger_ui/static --strip-components=2 "*/dist/"Documentation
More extensive documentation can be found here.
Extensions
Flask-Rebar is extensible! Here are some open source extensions:
Flask-Rebar-Auth0 - Auth0 authenticator for Flask-Rebar
Contributing
There is still work to be done, and contributions are encouraged! Check out the contribution guide for more information.
1 maintainer
Metadata
1 maintainer
Release files for flask-rebar 3.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| flask_rebar-3.5.0.tar.gz | 3.2 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| flask_rebar-3.5.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 6.4 MB
Release files / flask_rebar-3.5.0.tar.gz
| Download URL | flask_rebar-3.5.0.tar.gz |
|---|---|
| Size | 3.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
74110cdbbb4312b4298b84cbec05fc113221c1fcf2bfd09edeaf0017cfcae92a
|
|
BLAKE2b-256 checksum How to use checksums |
e94a13f5ade584934b8ae8b0c78753339c0d795d9b266681881821f042e0fc08
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / flask_rebar-3.5.0-py2.py3-none-any.whl
| Download URL | flask_rebar-3.5.0-py2.py3-none-any.whl |
|---|---|
| Size | 3.2 MB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
da62c8fe829c90f662eba0e82e54b5dfc7836deda6f9b856bd65784bdc06b0f0
|
|
BLAKE2b-256 checksum How to use checksums |
692f8be325c37b1a0dfcab3f3709a6e98a80dd62360ce94fe9306c48ea68227d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
