BODY - Code Search

docs_src/response_directly/tutorial002_py39.py

app = FastAPI()


@app.get("/legacy/")
def get_legacy_data():
    data = """<?xml version="1.0"?>
    <shampoo>
    <Header>
        Apply shampoo here.
    </Header>
    <Body>
        You'll have to use soap here.
    </Body>
    </shampoo>
    """

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Wed Dec 17 20:41:43 GMT 2025

- 354 bytes

- Click Count (0)

github.com/minio/minio

cmd/utils.go

// it is used to ignore custom encoding charset in S3 XML body.
func nopCharsetConverter(label string, input io.Reader) (io.Reader, error) {
	return input, nil
}

// xmlDecoder provide decoded value in xml.
func xmlDecoder(body io.Reader, v any, size int64) error {
	var lbody io.Reader
	if size > 0 {
		lbody = io.LimitReader(body, size)
	} else {
		lbody = body
	}
	d := xml.NewDecoder(lbody)

Created: Sun Dec 28 19:28:13 GMT 2025

- Last Modified: Sun Sep 28 20:59:21 GMT 2025

- 33K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs_src/body_multiple_params/tutorial005_py39.py

from typing import Union

from fastapi import Body, FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    description: Union[str, None] = None
    price: float
    tax: Union[float, None] = 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}

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Wed Dec 17 20:41:43 GMT 2025

- 407 bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/en/docs/tutorial/request-forms-and-files.md

/// warning

You can declare multiple `File` and `Form` parameters in a *path operation*, but you can't also declare `Body` fields that you expect to receive as JSON, as the request will have the body encoded using `multipart/form-data` instead of `application/json`.

This is not a limitation of **FastAPI**, it's part of the HTTP protocol.

///

## Recap { #recap }

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Sun Aug 31 09:15:41 GMT 2025

- 1.5K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs_src/body_multiple_params/tutorial005_an_py39.py

from typing import Annotated, Union

from fastapi import Body, FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    description: Union[str, None] = None
    price: float
    tax: Union[float, None] = None


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

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Sat Mar 18 12:29:59 GMT 2023

- 428 bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/ja/docs/tutorial/schema-extra-example.md

## `Field`の追加引数

後述する`Field`、`Path`、`Query`、`Body`などでは、任意の引数を関数に渡すことでJSON Schemaの追加情報を宣言することもできます:

{* ../../docs_src/schema_extra_example/tutorial002.py hl[4,10,11,12,13] *}

/// warning | 注意

これらの追加引数が渡されても、文書化のためのバリデーションは追加されず、注釈だけが追加されることを覚えておいてください。

///

## `Body`の追加引数

追加情報を`Field`に渡すのと同じように、`Path`、`Query`、`Body`などでも同じことができます。

例えば、`Body`にボディリクエストの`example`を渡すことができます:

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Mon Nov 18 02:25:44 GMT 2024

- 2.9K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/de/docs/advanced/openapi-callbacks.md

```
https://www.external.org/events/invoices/2expen51ve
```

mit einem JSON-Body, der etwa Folgendes enthält:

```JSON
{
    "description": "Payment celebration",
    "paid": true
}
```

und sie würde eine Response von dieser *externen API* mit einem JSON-Body wie dem folgenden erwarten:

```JSON
{
    "ok": true
}
```

/// tip | Tipp

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Wed Dec 10 13:54:34 GMT 2025

- 9.2K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/de/docs/tutorial/request-forms-and-files.md

/// warning | Achtung

Sie können mehrere `File`- und `Form`-Parameter in einer *Pfadoperation* deklarieren, aber Sie können nicht auch `Body`-Felder deklarieren, die Sie als JSON erwarten, da der Body des <abbr title="Request – Anfrage: Daten, die der Client zum Server sendet">Request</abbr> mittels `multipart/form-data` statt `application/json` kodiert sein wird.

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Sat Sep 20 15:10:09 GMT 2025

- 1.8K bytes

- Click Count (0)

github.com/tiangolo/fastapi

tests/test_tutorial/test_body/test_tutorial004.py

    assert response.json() == {
        "detail": [
            {
                "type": "missing",
                "loc": ["body", "name"],
                "msg": "Field required",
                "input": {},
            },
            {
                "type": "missing",
                "loc": ["body", "price"],
                "msg": "Field required",
                "input": {},
            },
        ]
    }

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Fri Dec 26 10:43:02 GMT 2025

- 6K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/zh/docs/tutorial/schema-extra-example.md

## `Field` 的附加参数

在 `Field`, `Path`, `Query`, `Body` 和其他你之后将会看到的工厂函数，你可以为JSON 模式声明额外信息，你也可以通过给工厂函数传递其他的任意参数来给JSON 模式声明额外信息，比如增加 `example`:

{* ../../docs_src/schema_extra_example/tutorial002_py310.py hl[2,8:11] *}

/// warning

请记住，传递的那些额外参数不会添加任何验证，只会添加注释，用于文档的目的。

///

## `Body` 额外参数

你可以通过传递额外信息给 `Field` 同样的方式操作`Path`, `Query`, `Body`等。

比如，你可以将请求体的一个 `example` 传递给 `Body`:

Created: Sun Dec 28 07:19:09 GMT 2025

- Last Modified: Mon Nov 18 02:25:44 GMT 2024

- 2.4K bytes

- Click Count (0)

Search Options