跳转至

# 请求

## Request declaration

First, you need to import `BaseModel` from `pydantic`:

    1

    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`:

    1
    2
    3
    4
    5
    6
    7

    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

    1

    from flask import request

like path, you need pass `query` to view function.

    1
    2
    3
    4
    5
    6
    7
    8

    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`.

    1
    2
    3
    4
    5
    6
    7
    8

    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`.

    1
    2
    3
    4
    5
    6
    7
    8

    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.

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13

    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:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21

    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.

     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

    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 model:

    1
    2
    3

    class BookQuery(BaseModel):
        age: int = Field(..., ge=2, le=4, description='Age')
        author: str = Field(None, description='Author')

More information to see BaseModel, and you can Customize the Field.

However, you can also use Field to extend Parameter Object. Here is an example:

`age` with `example` and `author` with `deprecated`.

    1
    2
    3

    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.