Flask-OpenAPI3-UI


NameFlask-OpenAPI3-UI JSON
Version 9.10.9 PyPI version JSON
download
home_page
SummaryNext generation OpenAPI v3 Integration for Flask based APIs. Based on Flasgger.
upload_time2024-02-05 11:38:22
maintainer
docs_urlNone
author
requires_python>=3.8.0
licenseThe MIT License (MIT) Copyright (c) 2022 Overflow Digital Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords flask swagger openapi python api rest openapi3
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Flask-OpenAPI

[![Python](https://img.shields.io/badge/python-3.8.0-blue.svg)](https://img.shields.io/badge/python-3.8..0-blue.svg)
[![PyPi](https://img.shields.io/pypi/v/Flask-OpenAPI3-UI.svg)](https://pypi.python.org/pypi/Flask-OpenAPI3-UI)
[![PyPi](https://img.shields.io/pypi/dm/Flask-OpenAPI3-UI.svg)](https://pypi.python.org/pypi/Flask-OpenAPI3-UI)
[![Flask-OpenAPI3-UI](https://snyk.io/advisor/python/Flask-OpenAPI3-UI/badge.svg)](https://snyk.io/advisor/python/Flask-OpenAPI3-UI)

Flask-OpenAPI is a Flask extension that provides integration with OpenAPI v2, v3, and v3.1 specifications easily.

## Features
- Easy OpenAPI specification definitions with the `openapi_spec` decorator
- Customisable Swagger UI
- Supports OpenAPI v2.0, v3.0, and v3.1
- Supports Swagger UI v2, v3, v4, and v5.

## Getting Started
To quickly install:
`pip install Flask-OpenAPI3-UI`

See the [Getting Started](https://github.com/overflowdigital/Flask-OpenAPI/wiki) documentation to get installed and setup with your Flask application.

## Contributing
See the [Contributing Guide](https://github.com/overflowdigital/Flask-OpenAPI/blob/main/CONTRIBUTING.md) for more information on contributing to the project.

## Security
We take security seriously, please read the [Security Advisory](https://github.com/overflowdigital/Flask-OpenAPI/blob/main/SECURITY.md) for more information.

## Code of Conduct
We take zero tolerance on attacks on our OSS community, please see the [Code of Conduct](https://github.com/overflowdigital/Flask-OpenAPI/blob/main/CODE_OF_CONDUCT.md) for more information

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "Flask-OpenAPI3-UI",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8.0",
    "maintainer_email": "Katerina Tiddy <katerina@overflow.digital>, Joshua Thompson-Lindley <joshua@overflow.digital>",
    "keywords": "flask,swagger,openapi,python,api,rest,openapi3",
    "author": "",
    "author_email": "Overflow Digital <team@overflow.digital>",
    "download_url": "https://files.pythonhosted.org/packages/66/5a/715a7c8673161fbfe79641ab56457be9e13d485c52fcb90e8a5e33b7ecc8/Flask-OpenAPI3-UI-9.10.9.tar.gz",
    "platform": null,
    "description": "# Flask-OpenAPI\n\n[![Python](https://img.shields.io/badge/python-3.8.0-blue.svg)](https://img.shields.io/badge/python-3.8..0-blue.svg)\n[![PyPi](https://img.shields.io/pypi/v/Flask-OpenAPI3-UI.svg)](https://pypi.python.org/pypi/Flask-OpenAPI3-UI)\n[![PyPi](https://img.shields.io/pypi/dm/Flask-OpenAPI3-UI.svg)](https://pypi.python.org/pypi/Flask-OpenAPI3-UI)\n[![Flask-OpenAPI3-UI](https://snyk.io/advisor/python/Flask-OpenAPI3-UI/badge.svg)](https://snyk.io/advisor/python/Flask-OpenAPI3-UI)\n\nFlask-OpenAPI is a Flask extension that provides integration with OpenAPI v2, v3, and v3.1 specifications easily.\n\n## Features\n- Easy OpenAPI specification definitions with the `openapi_spec` decorator\n- Customisable Swagger UI\n- Supports OpenAPI v2.0, v3.0, and v3.1\n- Supports Swagger UI v2, v3, v4, and v5.\n\n## Getting Started\nTo quickly install:\n`pip install Flask-OpenAPI3-UI`\n\nSee the [Getting Started](https://github.com/overflowdigital/Flask-OpenAPI/wiki) documentation to get installed and setup with your Flask application.\n\n## Contributing\nSee the [Contributing Guide](https://github.com/overflowdigital/Flask-OpenAPI/blob/main/CONTRIBUTING.md) for more information on contributing to the project.\n\n## Security\nWe take security seriously, please read the [Security Advisory](https://github.com/overflowdigital/Flask-OpenAPI/blob/main/SECURITY.md) for more information.\n\n## Code of Conduct\nWe take zero tolerance on attacks on our OSS community, please see the [Code of Conduct](https://github.com/overflowdigital/Flask-OpenAPI/blob/main/CODE_OF_CONDUCT.md) for more information\n",
    "bugtrack_url": null,
    "license": "The MIT License (MIT)  Copyright (c) 2022 Overflow Digital  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Next generation OpenAPI v3 Integration for Flask based APIs. Based on Flasgger.",
    "version": "9.10.9",
    "project_urls": {
        "repository": "https://github.com/overflowdigital/Flask-OpenAPI/"
    },
    "split_keywords": [
        "flask",
        "swagger",
        "openapi",
        "python",
        "api",
        "rest",
        "openapi3"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8e89637d1d6e1207c72e96e763918e130fa2cb39236e3eedd43fa626ec7b712f",
                "md5": "98e2b2adad7cb37afb162345664e0549",
                "sha256": "8320a0fd68fb2b02e925170d12256e54fe4905485c9829871785aed97e906b31"
            },
            "downloads": -1,
            "filename": "Flask_OpenAPI3_UI-9.10.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "98e2b2adad7cb37afb162345664e0549",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8.0",
            "size": 7105571,
            "upload_time": "2024-02-05T11:38:19",
            "upload_time_iso_8601": "2024-02-05T11:38:19.471574Z",
            "url": "https://files.pythonhosted.org/packages/8e/89/637d1d6e1207c72e96e763918e130fa2cb39236e3eedd43fa626ec7b712f/Flask_OpenAPI3_UI-9.10.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "665a715a7c8673161fbfe79641ab56457be9e13d485c52fcb90e8a5e33b7ecc8",
                "md5": "b315cc6f4baf258d1bb4e8a3a3f3bec2",
                "sha256": "a76b25053b31df78ffe2d0f5b7b1b06f770d3b7492ea1ccd1c6d51b82e08c064"
            },
            "downloads": -1,
            "filename": "Flask-OpenAPI3-UI-9.10.9.tar.gz",
            "has_sig": false,
            "md5_digest": "b315cc6f4baf258d1bb4e8a3a3f3bec2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.0",
            "size": 7027178,
            "upload_time": "2024-02-05T11:38:22",
            "upload_time_iso_8601": "2024-02-05T11:38:22.586086Z",
            "url": "https://files.pythonhosted.org/packages/66/5a/715a7c8673161fbfe79641ab56457be9e13d485c52fcb90e8a5e33b7ecc8/Flask-OpenAPI3-UI-9.10.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-05 11:38:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "overflowdigital",
    "github_project": "Flask-OpenAPI",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "flask-openapi3-ui"
}
        
Elapsed time: 0.18256s