معرفی شرکت ها

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

توضیحات

Flask wrapper for programmatically composing openapi specifications

ویژگی	مقدار
سیستم عامل	-
نام فایل	flaskdoc-0.2.0a1
نام	flaskdoc
نسخه کتابخانه	0.2.0a1
نگهدارنده	['Rowland Ogwara']
ایمیل نگهدارنده	[]
نویسنده	Rowland Ogwara
ایمیل نویسنده	r.ogwara@gmail.com
آدرس صفحه اصلی	https://github.com/kulgan/flaskdoc
آدرس اینترنتی	https://pypi.org/project/flaskdoc/
مجوز	Apache 2.0

flaskdoc ======== |PyPi version| |Python version| |ci| |docs| |license| |coverage| |code quality| FlaskDoc allows developers to programmatically compose openapi specifications for flask endpoints as a part of code without needing to write a separate yaml file, and it comes with SwaggerUI embedded. Its main focus is on documentation which frees developers to focus on getting their services coded. Why flaskdoc ------------ * Focus only on documentation and not introduce some fancy new way of using flask. * Easily add to existing code without needing to refactor of change the way the code has been written * Little or no learning curve, as long as a developer is comforatble using flask developers, they can use flaskdoc. to learn quickly and not distract So developers focus on writing code * SwaggerUI integration for quickly testing and iterating through versions * Automatic data model to JSON Schema transformation that allows for finer grain configuration Getting Started --------------- Visit `documentation <https://flaskdoc.readthedocs.io>`_ page for more details. Install """"""" from pypi .. code-block:: $ pip install flaskdoc from github .. code-block:: $ pip install https://github.com/kulgan/flaskdoc/tarball/master To run examples you will need to install the dev extension .. code-block:: $ pip install flaskdoc[dev] Register OpenAPI """""""""""""""" Add top level openapi objects like `Info <https://swagger.io/specification/#info-object>`_, `Contact <https://swagger.io/specification/#contact-object>`_, `License <https://swagger.io/specification/#license-object>`_ etc .. code-block:: python import flask from flaskdoc import register_openapi, swagger app = flask.Flask() # initialize app, add all the blueprints you care about # Create top level OpenAPI objects # the info object info = swagger.Info( title="Test", version="1.2.2", contact=swagger.Contact( name="Rowland", email="r.ogwara@gmail.com", url="https://github.com/kulgan" ), license=swagger.License(name="Apache 2.0", url="https://www.example.com/license"), ) # servers names and variables if necessary servers = [swagger.Server(url="http://localhost:15172")] # top level tags tags = [ swagger.Tag(name="admin", description="Secured Admin-Only calls"), swagger.Tag(name="developers", description="Operations available to regular developers"), ] security_schemes = { "api_key": swagger.ApiKeySecurityScheme(name="api_key"), } # register spec register_openapi(app, info=info, servers=servers, tags=tags, security=security_schemes) This adds the following endpoints to your list * /docs * /docs/openapi.yaml * /docs/openapi.json Start Documenting """"""""""""""""" Now start documenting you flask routes A simple post example .. code-block:: python blp = flask.Blueprint("Dummy", __name__, url_prefix="/v1") @swagger.POST( tags=["administrator"], description="Posts an Echo", responses={"201": swagger.ResponseObject(description="OK")}, ) @blp.route("/echo", methods=["POST"]) def post(): req = flask.request.get_json(force=True) return flask.jsonify(req), 200 A GET example with path parameter .. code-block:: python blp = flask.Blueprint("Dummy", __name__, url_prefix="/v1") @swagger.GET( tags=["getEcho"], operation_id="getEcho", parameters=[swagger.PathParameter(name="sample", schema=str)], description="Retrieve echos wit Get", responses={ "200": swagger.ResponseObject( description="Success", content=jo.PlainText(schema=jo.Email()), ) }, ) @blp.route("/echo/<string:sample>", methods=["GET"]) def echo(sample: str): """ Sample GET request Returns: Echos back whatever was sent """ return sample Run your app and visit `/docs` to see the generated openapi specs Running Examples ================ Two example projects are currently provided * `inventory <src/flaskdoc/examples/inventory.py>`_ * `petstore <src/flaskdoc/examples/petstore.py>`_ source `OpenAPI Petstore <https://petstore.swagger.io>`_ * `link-example <src/flaskdoc/examples/link_example/v0.py>`_ - source `OpenAPI link example <https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/link-example.json>`_ * `api-with-example <src/flaskdoc/examples/api_with_example.py>`_ - source `OpenAPI api_with_examples <https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/api-with-examples.json>`_ To run .. code-block:: bash $ pip install flaskdoc[dev] $ flaskdoc start -n petstore Contributing ------------ Don't hesitate to create a `Github issue <https://github.com/kulgan/flaskdoc/issues>`__ for any bugs or suggestions .. |ci| image:: https://github.com/kulgan/flaskdoc/workflows/ci/badge.svg :target: https://github.com/kulgan/flaskdoc/ :alt: build .. |PyPi version| image:: https://img.shields.io/pypi/v/flaskdoc.svg :target: https://pypi.org/project/flaskdoc/ :alt: PyPi downloads .. |Python version| image:: https://img.shields.io/pypi/pyversions/flaskdoc.svg :target: https://pypi.org/project/flaskdoc/ :alt: Python versions .. |license| image:: https://img.shields.io/pypi/l/flaskdoc.svg :target: https://pypi.org/project/flaskdoc/ :alt: license .. |docs| image:: https://readthedocs.org/projects/flaskdoc/badge/?version=latest :target: https://flaskdoc.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status .. |code quality| image:: https://app.codacy.com/project/badge/Grade/2dafebf021354a42aa62b11d6ab42654 :target: https://www.codacy.com/manual/kulgan/flaskdoc?utm_source=github.com&utm_medium=referral&utm_content=kulgan/flaskdoc&utm_campaign=Badge_Grade :alt: Code Quality .. |coverage| image:: https://app.codacy.com/project/badge/Coverage/2dafebf021354a42aa62b11d6ab42654 :target: https://www.codacy.com/manual/kulgan/flaskdoc?utm_source=github.com&utm_medium=referral&utm_content=kulgan/flaskdoc&utm_campaign=Badge_Coverage :alt: Coverage

نیازمندی

مقدار	نام
>=19.3	attrs
>=7.1	click
>=0.10	flask
>=5.1	PyYaml
-	black
-	click
-	coverage[toml]
-	flake8
-	openapi-spec-validator
-	pre-commit
-	pytest
-	pytest-cov
-	pytest-flask
-	sphinx
-	sphinx-rtd-theme
-	sphinxcontrib-napoleon
-	sphinx
-	sphinxcontrib-napoleon

زبان مورد نیاز

مقدار	نام
>=3.6	Python

نحوه نصب

نصب پکیج whl flaskdoc-0.2.0a1:

pip install flaskdoc-0.2.0a1.whl

نصب پکیج tar.gz flaskdoc-0.2.0a1:

pip install flaskdoc-0.2.0a1.tar.gz