Flask-Rebar combines flask, marshmallow, and swagger for robust REST services.
.. image:: https://readthedocs.org/projects/flask-rebar/badge/?version=latest :target: http://flask-rebar.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. image:: https://github.com/plangrid/flask-rebar/actions/workflows/tag.yml/badge.svg :target: https://github.com/plangrid/flask-rebar/actions/workflows/tag.yml :alt: CI Status
.. image:: https://badge.fury.io/py/flask-rebar.svg :target: https://badge.fury.io/py/flask-rebar :alt: PyPI status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/ambv/black :alt: Code style
.. image:: https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg :target: https://www.contributor-covenant.org/ :alt: Code of Conduct
|
Flask-Rebar combines flask <http://flask.pocoo.org/>
, marshmallow <https://marshmallow.readthedocs.io/en/latest/>
, and swagger <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md>
_ for robust REST services.
Swagger UI <https://swagger.io/swagger-ui/>
_... code-block:: python
from flask import Flask from flask_rebar import errors, Rebar from marshmallow import fields, Schema
from my_app import database
rebar = Rebar()
registry = rebar.create_handler_registry(prefix='/v1')
class TodoSchema(Schema): id = fields.Integer() complete = fields.Boolean() description = fields.String()
class GetTodosQueryStringSchema(Schema): complete = fields.Boolean()
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 <examples/todo/todo.py>
. Some example requests to this example app can be found at examples/todo_output.md <examples/todo/todo_output.md>
.
.. code-block::
pip install flask-rebar
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.
.. code-block::
curl -L https://api.github.com/repos/swagger-api/swagger-ui/tarball | tar -xv --directory=flask_rebar/swagger_ui/static --strip-components=2 "*/dist/"
More extensive documentation can be found here <https://flask-rebar.readthedocs.io>
_.
Flask-Rebar is extensible! Here are some open source extensions:
Flask-Rebar-Auth0 <https://github.com/Sytten/flask-rebar-auth0>
_ - Auth0 <https://auth0.com/>
_ authenticator for Flask-RebarThere is still work to be done, and contributions are encouraged! Check out the contribution guide <CONTRIBUTING.rst>
_ for more information.