View example in swagger ui

[ezeparziale]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the FastAPI documentation, with the integrated search.
• I already searched in Google "How to X in FastAPI" and didn't find any information.
• I already read and followed all the tutorial in the docs and didn't find an answer.
• I already checked if it is not related to FastAPI but to Pydantic.
• I already checked if it is not related to FastAPI but to Swagger UI.
• I already checked if it is not related to FastAPI but to ReDoc.

Commit to Help

• I commit to help with one of those options 👆

Example Code

from pydantic import BaseModel, ConfigDict, Field


class Team(BaseModel):
    model_config = ConfigDict(from_attributes=True)

    id: int = Field(description="ID of team", examples=[1])
    name: str = Field(
        description="Team name",
        examples=["test"],
    )


# Fastapi
from fastapi import FastAPI

app = FastAPI()


@app.post("/")
async def root(team: Team) -> "Team":
    new_team = {"id": team.id, "name": team.name}
    return new_team

Description

Finally I upgrade all my apis to fastapi 0.103.1 with pydantic v2
I use openapi examples and I have similar swagger ui except in schema where example dont appear.

v0.98.0

v0.103.1

I see all the examples but in the openapi.json, but in the swagger ui not, I miss some parameter ?

Operating System

Windows, macOS

Operating System Details

No response

FastAPI Version

0.103.1

Pydantic Version

2.3.0

Python Version

3.11

Additional Context

No response

[jack-t-lange]

I think this is more of a pydantic question, but hopefully I can help. Try adding the json_schema_extra attribute to your model_config.

https://fastapi.tiangolo.com/tutorial/schema-extra-example/

model_config = ConfigDict(
       from_attributes=True,
       json_schema_extra={
           "example": {
               "id": "1234",
               "name": "Foo",
           }
       },
   )

[YuriiMotov]

Initial code works well in current version (fastapi==0.103.1, pydantic==2.3.0)