Python OpenAPI UI bundles
=========================
This package provides the static files for `OpenAPI <https://swagger.io/specification/>`_ UI tools as a python package.
The following UI tools are included:
- `Swagger UI <https://github.com/swagger-api/swagger-ui>`_.
- `RapiDoc <https://github.com/mrin9/RapiDoc>`_.
- `ReDoc <https://github.com/Redocly/redoc>`_.
Flask usage example:
~~~~~~~~~~~~~~~~~~~~
.. code-block:: python
import flask
import openapi_ui_bundles
app = flask.Flask(__name__, static_folder=openapi_ui_bundles.swagger_ui.static_path, static_url_path='/')
if __name__ == "__main__":
app.run()
Swagger UI
----------
.. image:: images/swagger-ui-screenshot.png
:width: 1024
:alt: Swagger UI example
RapiDoc
-------
.. image:: images/rapidoc-screenshot.png
:width: 1024
:alt: RapiDoc UI example
ReDoc
-----
.. image:: images/redoc-screenshot.png
:width: 1024
:alt: ReDoc UI example
Raw data
{
"_id": null,
"home_page": "https://github.com/dapper91/python-openapi-ui-bundles",
"name": "openapi-ui-bundles",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": null,
"keywords": "documentation, api-documentation, api-schema, swagger, swagger-ui, swagger-documentation, swagger-specification, openapi, openapi-ui, openapi-specification, openapi-documentation, redoc, rapidoc",
"author": "Dmitry Pershin",
"author_email": "dapper1291@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5d/22/d38dcd8428812700252e98d02e4baac9b440dafcc711117a8b88a40ea261/openapi_ui_bundles-0.3.0.tar.gz",
"platform": null,
"description": "Python OpenAPI UI bundles\n=========================\n\nThis package provides the static files for `OpenAPI <https://swagger.io/specification/>`_ UI tools as a python package.\nThe following UI tools are included:\n\n- `Swagger UI <https://github.com/swagger-api/swagger-ui>`_.\n- `RapiDoc <https://github.com/mrin9/RapiDoc>`_.\n- `ReDoc <https://github.com/Redocly/redoc>`_.\n\n\nFlask usage example:\n~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n import flask\n import openapi_ui_bundles\n\n app = flask.Flask(__name__, static_folder=openapi_ui_bundles.swagger_ui.static_path, static_url_path='/')\n\n if __name__ == \"__main__\":\n app.run()\n\n\nSwagger UI\n----------\n\n.. image:: images/swagger-ui-screenshot.png\n :width: 1024\n :alt: Swagger UI example\n\n\nRapiDoc\n-------\n\n.. image:: images/rapidoc-screenshot.png\n :width: 1024\n :alt: RapiDoc UI example\n\n\nReDoc\n-----\n\n.. image:: images/redoc-screenshot.png\n :width: 1024\n :alt: ReDoc UI example\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Python static file bundles for OpenAPI UI tools",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/dapper91/python-openapi-ui-bundles",
"Source": "https://github.com/dapper91/python-openapi_ui_bundles"
},
"split_keywords": [
"documentation",
" api-documentation",
" api-schema",
" swagger",
" swagger-ui",
" swagger-documentation",
" swagger-specification",
" openapi",
" openapi-ui",
" openapi-specification",
" openapi-documentation",
" redoc",
" rapidoc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5d22d38dcd8428812700252e98d02e4baac9b440dafcc711117a8b88a40ea261",
"md5": "68719db159ba4d1ca70315865c15854c",
"sha256": "27306ea676c8e4645405d9a4fdd33232c0f42d934754f9e832b5b63bbafe2797"
},
"downloads": -1,
"filename": "openapi_ui_bundles-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "68719db159ba4d1ca70315865c15854c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 999920,
"upload_time": "2024-10-31T17:24:31",
"upload_time_iso_8601": "2024-10-31T17:24:31.314074Z",
"url": "https://files.pythonhosted.org/packages/5d/22/d38dcd8428812700252e98d02e4baac9b440dafcc711117a8b88a40ea261/openapi_ui_bundles-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-31 17:24:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dapper91",
"github_project": "python-openapi-ui-bundles",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openapi-ui-bundles"
}
JSON
