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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
## Request declaration
First, you need to import `BaseModel` from `pydantic`:
```python
from pydantic import BaseModel
```
### path
Request parameter in rules，**`@app.get('/book/<int:bid>')`**.
You have to declare **path** model as a class that inherits from **`BaseModel`**:
```python hl_lines="6"
class BookPath(BaseModel):
bid: int = Field(..., description='book id')
@app.get('/book/<int:bid>', tags=[book_tag], security=security)
def get_book(path: BookPath):
...
```
### query
Receive flask **`request.args`**.
!!! info
```python
from flask import request
```
like [path](#path), you need pass **`query`** to view function.
```python hl_lines="7"
class BookQuery(BaseModel):
age: int | None = Field(..., ge=2, le=4, description='Age')
author: str = Field(None, min_length=2, max_length=4, description='Author')
@app.get('/book/<int:bid>', tags=[book_tag], security=security)
def get_book(path: BookPath, query: BookQuery):
...
```
### form
Receive flask **`request.form`** and **`request.files`**.
```python hl_lines="7"
class UploadFileForm(BaseModel):
file: FileStorage # request.files["file"]
file_type: str = Field(None, description="File type")
@app.post('/upload')
def upload_file(form: UploadFileForm):
...
```
### body
Receive flask **`request.json`**.
```python hl_lines="7"
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')
@app.post('/book', tags=[book_tag])
def create_book(body: BookBody):
...
```
### header
Receive flask **`request.headers`**.
### cookie
Receive flask **`request.cookies`**.
### raw
Receive flask **`request`** and no data validation.
```python
from flask_openapi3 import RawModel
class BookRaw(RawModel):
mimetypes = ["text/csv", "application/json"]
@app.post("/book")
def get_book(raw: BookRaw):
# raw equals to flask.request
print(raw.data)
print(raw.mimetype)
return "ok"
```
## @validate_request
Sometimes you want to delay the verification request parameters, such as after login verification:
```python
from flask_openapi3 import validate_request
def login_required():
def decorator(func):
@wraps(func)
def wrapper(*args, **kwargs):
if not request.headers.get("Authorization"):
return {"error": "Unauthorized"}, 401
return func(*args, **kwargs)
return wrapper
return decorator
@app.get("/book")
@login_required
@validate_request()
def get_book(query: BookQuery):
...
```
### Custom kwargs are maintained
When your 'auth decorator' injects custom kwargs, these will be passed on to the final function for you to use.
Any kwargs which are part of the 'path' will have been consumed at this point and can only be referenced using the `path`.
So avoid using kwarg-names which overlap with the path.
```python
from flask_openapi3 import validate_request
from functools import wraps
def login_required():
def decorator(func):
@wraps(func)
def wrapper(*args, **kwargs):
if not request.headers.get("Authorization"):
return {"error": "Unauthorized"}, 401
kwargs["client_id"] = "client1234565"
return func(*args, **kwargs)
return wrapper
return decorator
@app.get("/book")
@login_required()
@validate_request()
def get_book(query: BookQuery, client_id:str = None):
print(f"Current user identified as {client_id}")
...
```
## Request model
First, you need to define a [pydantic](https://github.com/pydantic/pydantic) model:
```python
class BookQuery(BaseModel):
age: int = Field(..., ge=2, le=4, description='Age')
author: str = Field(None, description='Author')
```
More information to see [BaseModel](https://docs.pydantic.dev/latest/usage/models/), and you
can [Customize the Field](https://docs.pydantic.dev/latest/usage/fields/).
However, you can also use **Field** to extend [Parameter Object](https://spec.openapis.org/oas/v3.1.0#parameter-object).
Here is an example:
`age` with **`example`** and `author` with **`deprecated`**.
```python
class BookQuery(BaseModel):
age: int = Field(..., ge=2, le=4, description='Age', json_schema_extra={"example": 3})
author: str = Field(None, description='Author', json_schema_extra={"deprecated": True})
```
Magic:
More available fields to see [Parameter Object Fixed Fields](https://spec.openapis.org/oas/v3.1.0#fixed-fields-9).
|
