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-rebar
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 Jul 07, 2022
81 May 16, 2022
0 Apr 17, 2022
1 Nov 14, 2021
2 Sep 28, 2022
0 Jul 31, 2021
8 Jan 02, 2023
18 Oct 15, 2022
55 Aug 28, 2022
107 Nov 16, 2022
9 Nov 26, 2022
11 Sep 23, 2022
0 Jul 11, 2021
92 Dec 31, 2022
1 Nov 17, 2022
1 Dec 01, 2022
5 Jun 14, 2022
1.6k Dec 19, 2022
2 May 13, 2022
2 Nov 04, 2021