flask-openapi3 1.1.3

Generate REST API and OpenAPI documentation for your Flask project.

Generate REST API and OpenAPI documentation for your Flask project.

Flask OpenAPI3 is a web API framework based on Flask. It uses Pydantic to verify data and automatic generation of interaction documentation: Swagger UI, ReDoc and RapiDoc.

The key features are:

• Easy to code: Easy to use and easy to learn

• Standard document specification: Based on OpenAPI Specification

• Interactive OpenAPI documentation: Swagger UI, Redoc and RapiDoc

• Data validation: Fast data verification based on Pydantic

Requirements

Python 3.7+

flask-openapi3 be dependent on the following libraries:

• Flask for the web app.
• Pydantic for the data validation.

Installation

pip install -U flask-openapi3

A Simple Example

Here's a simple example, further go to the Example.

from pydantic import BaseModel

from flask_openapi3 import Info, Tag
from flask_openapi3 import OpenAPI

info = Info(title='book API', version='1.0.0')
app = OpenAPI(__name__, info=info)

book_tag = Tag(name='book', description='Some Book')


class BookQuery(BaseModel):
    age: int
    author: str


@app.get('/book', tags=[book_tag])
def get_book(query: BookQuery):
    """get books
    get all books
    """
    return {
        "code": 0,
        "message": "ok",
        "data": [
            {"bid": 1, "age": query.age, "author": query.author},
            {"bid": 2, "age": query.age, "author": query.author}
        ]
    }


if __name__ == '__main__':
    app.run(debug=True)

API Document

Run the simple example, and go to http://127.0.0.1:5000/openapi.

You will see the documentation: Swagger UI, Redoc and RapiDoc.