https://github.com/dapper91/python-openapi-ui-bundles

This package provides the static files for OpenAPI UI tools as a python package.
https://github.com/dapper91/python-openapi-ui-bundles

api-documentation api-schema documentation openapi openapi-documentation openapi-specification openapi-ui rapidoc redoc swagger swagger-documentation swagger-specification swagger-ui

Last synced: about 2 months ago
JSON representation

This package provides the static files for OpenAPI UI tools as a python package.

• Host: GitHub
• URL: https://github.com/dapper91/python-openapi-ui-bundles
• Owner: dapper91
• License: apache-2.0
• Created: 2021-08-06T08:26:21.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-31T17:23:30.000Z (3 months ago)
• Last Synced: 2024-11-14T13:56:57.675Z (2 months ago)
• Topics: api-documentation, api-schema, documentation, openapi, openapi-documentation, openapi-specification, openapi-ui, rapidoc, redoc, swagger, swagger-documentation, swagger-specification, swagger-ui
• Language: Python
• Homepage:
• Size: 6.48 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Python OpenAPI UI bundles

=========================

This package provides the static files for `OpenAPI `_ UI tools as a python package.

The following UI tools are included:

- `Swagger UI `_.

- `RapiDoc `_.

- `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