Using a single Body parameter, the JSON format will report an error

[wxq0309]

Description

Using a single Body parameter, the JSON format will report an error

Additional context

@router.post("/test/")
async def test(abd: str=Body(...)):
    print(abd)               ---error

@router.post("/test/")
async def test(abd: str=Body(...), acd: str=Body(...)):
    print(abd)               ---right

Using a single Body parameter, the JSON format will report an error

[phy25]

What JSON format is producing an error? What is the error message? Could you provide an example request?

[wxq0309]

What JSON format is producing an error? What is the error message? Could you provide an example request?

I want to send a JSON data in the format of {" abd ":" message "}, but when I use a single Body parameter setting, send it in the above JSON format, it will prompt

{
  "detail": [
    {
      "loc": [
        "body",
        "abd"
      ],
      "msg": "str type expected",
      "type": "type_error.str"
    }
  ]
}

[kajogo777]

@wxq0309 how did you resolve this? I am having the same issue

[wxq0309]

@ wxq0309您如何解决此问题？我有相同的问题

This can be done by setting the Embed property

item: Item = Body(..., embed=True)

example:
from fastapi import Body, FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None


@app.put("/items/{item_id}")
async def update_item(*, item_id: int, item: Item = Body(..., embed=True)):
    results = {"item_id": item_id, "item": item}
    return results

[kajogo777]

thank you

[tiangolo]

Thanks for the discussion here everyone! And thanks @wxq0309 for closing the issue and reporting back your solution. 👍

[BillGrim]

@ wxq0309您如何解决此问题？我有相同的问题

This can be done by setting the Embed property

item: Item = Body(..., embed=True)

example:
from fastapi import Body, FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None


@app.put("/items/{item_id}")
async def update_item(*, item_id: int, item: Item = Body(..., embed=True)):
    results = {"item_id": item_id, "item": item}
    return results

In my opinion, the condition of your solution is already different from the problem you met, which is "Single parameter declared with fastapi.Body requests str formatted rather than json formatted request body".

I read the official doc singular-values-in-body, but the demo contains extra paramters(request param, pydantic model).

In my case, I have many apis that needs only a single post body param.

So Is there a way to declare a single param in body of a post api without using pydantic?