Overview

Installation

pip install flask-marshmallow-openapi

What does it do?

Searches your codebase for marshmallow schemas and 🎖️ decorated 🎖️ Flask routes.

It then produces swagger.json and injects it into self-hosted ReDoc and SwaggerUI documentation viewers.

api = flask.Blueprint("my_api", __name__)


class BookSchema(ma.Schema):
    id = ma.fields.Integer(as_string=True)
    title = ma.fields.String(allow_none=False)
    publisher = ma.fields.String(allow_none=False)
    isbn = ma.fields.String(allow_none=False)


@open_api.get_list(BookSchema)
@api.route("/books", methods=["GET"])
def books_list():
    return "<p>Hello, World!</p>"


app = flask.Flask(__name__)
app.register_blueprint(api, url_prefix="/v1")


conf = OpenAPISettings(
    api_version="v1", api_name="My API", app_package_name="my_api", mounted_at="/v1"
)
docs = OpenAPI(config=conf)
docs.init_app(app)

Contents

• Getting started
  • Full example application
• Documenting GET routes
  • GET a list of objects
  • GET details of an object
  • GET routes returning single object without ID parameter
• Documenting POST routes
• Documenting PATCH routes
  • PATCH routes without ID
• Documenting DELETE routes
• Markdown and docstrings
• Documenting API authentication schemes
  • Routes that don’t require authentication
  • Routes requiring refresh_token
• Documenting URL parameters
  • Path parameters
  • Query parameters
• Grouping routes’ documentation: tags
• OpenAPI middleware
  • Custom OpenAPI template
  • Changelog loader
• Excluding and overriding generated endpoint documentation
• Documenting custom marshmallow field types
• Serving docs statically via nginx
• License

• Index

• Module Index

• Search Page