معرفی شرکت ها
flask-rebar-2.3.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Flask-Rebar combines flask, marshmallow, and swagger for robust REST services.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | flask-rebar-2.3.0 |
| نام | flask-rebar |
| نسخه کتابخانه | 2.3.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Barak Alon |
| ایمیل نویسنده | barak.s.alon@gmail.com |
| آدرس صفحه اصلی | https://github.com/plangrid/flask-rebar |
| آدرس اینترنتی | https://pypi.org/project/flask-rebar/ |
| مجوز | MIT |
Flask-Rebar
===========
.. 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.
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 <https://swagger.io/swagger-ui/>`_.
* **Error Handling** - Uncaught exceptions from Flask-Rebar are converted to appropriate HTTP errors.
Example
-------
.. 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()
# 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 <examples/todo/todo.py>`_. Some example requests to this example app can be found at `examples/todo_output.md <examples/todo/todo_output.md>`_.
Installation
------------
.. code-block::
pip install flask-rebar
Documentation
-------------
More extensive documentation can be found `here <https://flask-rebar.readthedocs.io>`_.
Extensions
----------
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-Rebar
Contributing
------------
There is still work to be done, and contributions are encouraged! Check out the `contribution guide <CONTRIBUTING.rst>`_ for more information.
نیازمندی
| مقدار | نام |
|---|---|
| <3,>=1.0 | Flask |
| <4,>=3.0 | marshmallow |
| ==22.3.0 | black |
| ==0.5.3 | bumpversion |
| <9.0.0,>=8.1.3 | click |
| ==4.0.1 | flake8 |
| <4.0.0,>=3.0.4 | gitchangelog |
| ==3.0.2 | jsonschema |
| ~=2.3 | marshmallow-objects |
| ==0.1.1 | parametrize |
| >=1.14.4 | pre-commit |
| ~=6.2 | pytest |
| ~=1.0 | pytest-order |
| ==1.7.0 | Sphinx |
| ==0.2.4 | sphinx-rtd-theme |
| ~=1.5 | marshmallow-enum |
نحوه نصب
نصب پکیج whl flask-rebar-2.3.0:
pip install flask-rebar-2.3.0.whl
نصب پکیج tar.gz flask-rebar-2.3.0:
pip install flask-rebar-2.3.0.tar.gz