Generate RESTful API and OpenAPI document for your Flask project.
Project description
flask-openapi3
Generate RESTful API and OpenAPI document for your Flask project.
Requirements
Python 3.7+
flask-openapi3 be dependent on the following libraries:
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 docs
Run the simple example, and go to http://127.0.0.1:5000/openapi.
You will see the document: Swagger UI , Redoc and RapiDoc.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
flask-openapi3-1.0.0.tar.gz
(955.1 kB
view hashes)
Built Distribution
flask_openapi3-1.0.0-py3-none-any.whl
(962.8 kB
view hashes)
Close
Hashes for flask_openapi3-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46dd8d898d5c540b845159b089eac13b48e3b53e4e4c5906e10442c1b0234e2d |
|
MD5 | 144ec579da74e6523817338444186484 |
|
BLAKE2b-256 | d5b5b77b661ee9dbe3e44823baac21969f102bea2d7ad98c27e57d2f8be3eeb7 |