1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
# -*- coding: utf-8 -*-
# @Author : llc
# @Time : 2021/4/28 11:24
from http import HTTPStatus
from pydantic import BaseModel, Field
from flask_openapi3 import ExternalDocumentation, Info, OpenAPI, Server, Tag
info = Info(title="book API", version="1.0.0")
# Basic Authentication Sample
basic = {"type": "http", "scheme": "basic"}
# JWT Bearer Sample
jwt = {"type": "http", "scheme": "bearer", "bearerFormat": "JWT"}
# API Key Sample
api_key = {"type": "apiKey", "name": "api_key", "in": "header"}
# Implicit OAuth2 Sample
oauth2 = {
"type": "oauth2",
"flows": {
"implicit": {
"authorizationUrl": "https://example.com/api/oauth/dialog",
"scopes": {"write:pets": "modify pets in your account", "read:pets": "read your pets"},
}
},
}
security_schemes = {"jwt": jwt, "api_key": api_key, "oauth2": oauth2, "basic": basic}
class NotFoundResponse(BaseModel):
code: int = Field(-1, description="Status Code")
message: str = Field("Resource not found!", description="Exception Information")
app = OpenAPI(__name__, info=info, security_schemes=security_schemes, responses={404: NotFoundResponse})
book_tag = Tag(name="book", description="Some Book")
security = [{"jwt": []}, {"oauth2": ["write:pets", "read:pets"]}, {"basic": []}]
class BookPath(BaseModel):
bid: int = Field(..., description="book id", json_schema_extra={"deprecated": True, "example": 100})
class BookQuery(BaseModel):
age: int | None = Field(None, description="Age")
s_list: list[str] = Field(None, alias="s_list[]", description="some array")
class BookBody(BaseModel):
age: int | None = Field(..., ge=2, le=4, description="Age")
author: str = Field(None, min_length=2, max_length=4, description="Author")
class BookBodyWithID(BaseModel):
bid: int = Field(..., description="book id")
age: int | None = Field(None, ge=2, le=4, description="Age")
author: str = Field(None, min_length=2, max_length=4, description="Author")
class BookResponse(BaseModel):
code: int = Field(0, description="Status Code")
message: str = Field("ok", description="Exception Information")
data: BookBodyWithID | None
@app.get(
"/book/<int:bid>",
tags=[book_tag],
summary="new summary",
description="new description",
operation_id="get_book_id",
external_docs=ExternalDocumentation(
url="https://www.openapis.org/", description="Something great got better, get excited!"
),
responses={200: BookResponse},
security=security,
servers=[Server(url="https://www.openapis.org/", description="openapi")],
)
def get_book(path: BookPath):
"""Get a book
to Get some book by id, like:
http://localhost:5000/book/3
"""
if path.bid == 4:
return NotFoundResponse().model_dump(), 404
return {"code": 0, "message": "ok", "data": {"bid": path.bid, "age": 3, "author": "no"}}
# set doc_ui False disable openapi UI
@app.get("/book", doc_ui=True, deprecated=True)
def get_books(query: BookQuery):
"""get books
to get all books
"""
print(query)
return {
"code": 0,
"message": "ok",
"data": [{"bid": 1, "age": query.age, "author": "a1"}, {"bid": 2, "age": query.age, "author": "a2"}],
}
@app.post("/book", tags=[book_tag], responses={200: BookResponse})
def create_book(body: BookBody):
print(body)
return {"code": 0, "message": "ok"}, HTTPStatus.OK
@app.put("/book/<int:bid>", tags=[book_tag])
def update_book(path: BookPath, body: BookBody):
print(path)
print(body)
return {"code": 0, "message": "ok"}
@app.delete("/book/<int:bid>", tags=[book_tag], doc_ui=False)
def delete_book(path: BookPath):
print(path)
return {"code": 0, "message": "ok"}
if __name__ == "__main__":
app.run(debug=True)
|
