Flask-Rebar combines flask, marshmallow, and swagger for robust REST services.
Project description
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.
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.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size flask_rebar-1.12.2-py2.py3-none-any.whl (4.3 MB) | File type Wheel | Python version py2.py3 | Upload date | Hashes View |
Filename, size flask-rebar-1.12.2.tar.gz (4.2 MB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for flask_rebar-1.12.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82b4d5a0f3862c6d658284e93512cb768717b0976eedbbc5b94f58877c9f7afb |
|
MD5 | 8a8aca1deb3e8d116b2615f302eb6063 |
|
BLAKE2-256 | 6ab7f413bd98bf8f08739bd92952ebb7bb3dbdea5d762063a50eebf686280285 |