Ask Your Question
4

Can FastAPI/OpenAPI support multiple response models?

asked 2022-02-22 11:00:00 +0000

lakamha gravatar image

edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted
2

answered 2022-06-27 12:00:00 +0000

david gravatar image

Yes, FastAPI/OpenAPI supports multiple response models. You can define multiple response models in the OpenAPI specification using the responses section with different response codes. For example:

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    price: float

class ErrorResponse(BaseModel):
    message: str

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    if item_id == 0:
        return {"error": "item_id must be greater than zero"}
    elif item_id == 1:
        return ErrorResponse(message="Item not found")
    else:
        return Item(name="Item " + str(item_id), price=1.23)

In the example above, we define two response models: Item and ErrorResponse. We use Item as the response model for successful requests and ErrorResponse as the response model for error requests. The responses section in the OpenAPI specification will show the different models for each possible response code.

edit flag offensive delete link more

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account. This space is reserved only for answers. If you would like to engage in a discussion, please instead post a comment under the question or an answer that you would like to discuss

Add Answer


Question Tools

Stats

Asked: 2022-02-22 11:00:00 +0000

Seen: 10 times

Last updated: Jun 27 '22