How to indicate that the response body is a List in Swagger UI docs using FastAPI?

Question

I describe the structure of the outgoing JSON in the model class, however I cannot make the output as a list.

My model class:

class versions_info(BaseModel):
    """ List of versions """
    version : str = Field(..., title="Version",example="2.1.1")
    url :   str = Field(..., title="Url",example="https://ocpi.wedwe.ww/ocpi/2.1.1/")

And in the documentation I see:

However, I need it to be displayed as:

[
  {
    "version": "2.1.1",
    "url": "https://www.server.com/ocpi/2.1.1/"
  },
  {
    "version": "2.2",
    "url": "https://www.server.com/ocpi/2.2/"
  }
]

What am I doing wrong?

Since you didn't include your route definition it's hard to say - but usually you do @app.get('/foo', response_model=List[versions_info]) to indicate that you're returning a list instead of a single object. — MatsLindh
– MatsLindh, Commented Sep 8, 2022 at 13:09
Hi Pavel You are creating ocpi integration for existing central system as well written in Python ? — Igor
– Igor, Commented Oct 9, 2022 at 17:06
Yes,we are the developers of the electric charging stations platform — Pavel Gribov
– Pavel Gribov, Commented Oct 12, 2022 at 4:51

MatsLindh · Accepted Answer · 2022-09-08 13:46:35Z

3

You can indicate that you're returning a List by wrapping the response_model you've defined in List[<model>].

So in your case it'd be:

@app.get('/foo', response_model=List[versions_info])

edited Sep 8, 2022 at 13:46

answered Sep 8, 2022 at 13:39

MatsLindh

53.5k5 gold badges70 silver badges97 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to indicate that the response body is a List in Swagger UI docs using FastAPI?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related