FastAPI Swagger 文档显示不正确的响应状态？-解网

问：

通过 FastAPI（下面的代码片段）实现的路由工作正常。

@app.post(path='/user/create/')
async def create_user(response: Response,
                      email: str = Form(),
                      password: str = Form()) -> None:
    """
    Create a new user with this route.
    Possible responses:
    201: New User Created
    400: Bad email id supplied.
    409: User already signed up, hence causing conflict with existing id.
    """
    logging.info(msg=f'New user sign up request from {email}.')
    try:
        user: WebUser = WebUser(email=email, password=password)
        # Either 409 or 201
        response.status_code = [CONFLICT, CREATED][await user.create_new()]
    except ValidationError:
        logging.error(
            msg=f'User creation for {email} failed because of bad request.')
        response.status_code = BAD_REQUEST  # 400

但是 FastAPI swagger 文档显示了不正确的（实际上是完全随机的）响应。这是屏幕截图。

因此，它没有显示 409 和 400，而是以某种方式显示 422 作为可能的响应。此外，成功的响应实际上是 201。

那么，FastAPI 是如何在幕后形成这些文档的，我是否做错了什么来误导它呢？还是 FastAPI 中的错误？

python fastapi httpresponse asgi

import random
import logging
import pydantic
from fastapi import FastAPI, Response, Form
from fastapi.responses import JSONResponse

app = FastAPI()


class BaseModel(pydantic.BaseModel):
    pass


class Message(BaseModel):
    message: str


class WebUser(BaseModel):
    email: str
    password: str


def user_create_new(user: WebUser):
    if random.randint(0, 100) > 50:
        pass
    else:
        raise ValueError()


@app.post(
    path="/user/create",
    responses={400: {"model": Message}, 409: {"model": Message}},
)
async def create_user(
    response: Response, email: str = Form(), password: str = Form()
) -> None:
    logging.info(msg=f"New user sign up request from {email}.")
    user: WebUser = WebUser(email=email, password=password)
    try:
        user_create_new(user)
        return Message(message=f"Created user {email}")
    except ValueError:
        return JSONResponse(
            status_code=400, content=Message(message="Unable to create user").dict()
        )

然后 http://localhost/openapi 得到我们：

根据文档，这是记录其他响应代码的方法，以便它们将显示在生成的 openapi 规范中。 W/r/t 到 422 响应，这是响应模型的一部分——这是 FastAPI 在 pydantic 验证失败时将返回的内容，因此从 FastAPI 的角度来看，每个方法都可以返回 422 状态。

上一个：Drupal 批处理 - 如何在完成回调中使用 StreamedResponse 重定向

下一个：为什么通过邮递员将主数据导入囊维度时验证失败？

FastAPI Swagger 文档显示不正确的响应状态？

FastAPI Swagger Documentation Showing Incorrect Response Status?

评论

评论