Flask-OpenAPI3-UI 1.8.0

Next generation OpenAPI v3 Integration for Flask based APIs. Based on Flasgger.

Flask-OpenAPI3-UI

Next generation OpenAPI v3 Integration for Flask based APIs. Based on Flasgger.

Install

pip install Flask-OpenAPI3-UI

Usage

You can start your Swagger spec with any default data providing a template:

from flask_openapi import Swagger

def main():
  app = create_app()
  app.config['SWAGGER'] = {
      "uiversion": 3,
      "openapi": "3.0.3",
      "info": {
          "title": "API documentation",
          "description": "API docs for ",
          "version": 1.0.0
      },
      "swagger_ui": True,
      "basePath": "/api",  # base bash for blueprint registration
      "components": {
          "securitySchemes": {
              "bearerAuth": {
                  "type": "http",
                  "scheme": "bearer",
                  "bearerFormat": "JWT"
              }
          }
      },
      "title": "API docs",
      "optional_fields": ["components", "tags", "paths"],
      "doc_dir": "/home/admin/flaskapp/src/api/",
  }
  Swagger(app=app)

And then the template is the default data unless some view changes it. You can also provide all your specs as template and have no views. Or views in external APP.