flask-openapi3-elements

What it is and what it does

flask-openapi3-elements is a plugin that adds Stoplight Elements as an interactive UI option for displaying OpenAPI documentation in Flask applications built with flask-openapi3. It acts as an optional visual layer on top of the core flask-openapi3 framework, allowing developers to choose Elements as their preferred API documentation interface instead of the default or other bundled UI options like Swagger, Redoc, or RapiDoc.

The package is installed as a standalone wheel and integrates directly with flask-openapi3 to render API schemas in the Elements UI format. It is one of several UI plugin options available in the flask-openapi ecosystem, all installed separately to keep the core framework lightweight. The package is actively maintained, supports current Python versions (3.8+), and carries no known security vulnerabilities.

Use it for:

• Display OpenAPI documentation using Stoplight Elements instead of Swagger UI in a Flask REST API.
• Provide an alternative interactive API explorer for teams that prefer Elements' design or features.
• Bundle multiple UI options in a single Flask application and let users choose their preferred documentation interface.
• Integrate Elements-based API docs into a Flask microservice for internal or external API consumers.
• Create a lightweight API documentation portal without adding the full Swagger UI package overhead.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides the Stoplight Elements UI for displaying OpenAPI documentation in flask-openapi3 applications, enabling interactive API exploration and testing.

Yes, if you are already using flask-openapi3 and prefer the Stoplight Elements UI for your API documentation. The package is actively maintained, carries no security issues, has low install friction, and uses a permissive MIT license. Install it only if you specifically want Elements; the parent flask-openapi3 package offers other UI options that may suit your needs equally well.

Install

flask-openapi3-elements on PyPI

pip install flask-openapi3-elements

uv add flask-openapi3-elements

poetry add flask-openapi3-elements

Installing flask-openapi3-elements

Before you install

Low friction installation as a pure Python wheel. Actively maintained with recent commits and stable production status, though the package itself is relatively young (first release mid-2024) and has modest adoption at 79327 monthly downloads.

License in practice

MIT license permits free use, modification, and distribution with minimal restrictions, making it suitable for both open-source and commercial projects.

Quickstart

pip install flask-openapi3-elements

from flask_openapi3 import OpenAPI

app = OpenAPI(__name__, info=dict(title="API", version="1.0.0"))

@app.get("/hello")
def hello():
    return {"message": "Hello"}

if __name__ == "__main__":
    app.run()

Requires Python 3.8 or later; flask-openapi3 must be installed as the runtime dependency.

Verify before relying

• Whether Elements UI offers specific advantages over the other bundled UI options (Swagger, Redoc, RapiDoc, RapiPdf, Scalar) for particular use cases.
• Whether this package can be installed standalone or requires the parent flask-openapi3 package to be installed first.

Package facts

Evidence: flask_openapi3_elements-9.0.15-py3-none-any.whl

Tags

More Dynamic Content packages