class DummyClient:
    async def get_people(self) -> list:
        return ["John Doe", "Jane Doe"]

    async def close(self) -> None:
        pass


async def get_client() -> AsyncGenerator[DummyClient, None]:
    client = DummyClient()
    yield client
    await client.close()


Client = Annotated[DummyClient, Depends(get_client)]


@pytest.fixture(name="client")

								<i class="fa fa-filter" aria-hidden="true"></i>
								<la:message key="labels.chat_filter" />
								<span id="filterBadge" class="badge rounded-pill bg-primary d-none">0</span>
							</button>
							<button type="button" id="newChatBtn" class="btn btn-outline-secondary btn-sm" aria-label="<la:message key="labels.chat_new_chat" />">
								<i class="fa fa-plus" aria-hidden="true"></i>

<img src="/img/tutorial/separate-openapi-schemas/image02.png">
</div>

這代表該欄位一定會有值，只是有時候值可能是 `None`（在 JSON 中為 `null`）。

因此，使用你 API 的用戶端不必檢查值是否存在，可以假設該欄位一定存在；只是有些情況下它的值會是預設的 `None`。

在 OpenAPI 中，描述這種情況的方式是將該欄位標記為必填，因為它一定存在。

因此，同一個模型的 JSON Schema 會依用於輸入或輸出而不同：

- 用於輸入時，`description` 不是必填
- 用於輸出時，`description` 是必填（且可能為 `None`，在 JSON 中為 `null`）

### 文件中的輸出模型 { #model-for-output-in-docs }

<img src="/img/tutorial/separate-openapi-schemas/image02.png">
</div>

这意味着它**总会有值**，只是有时该值可能为 `None`（在 JSON 中是 `null`）。

这也意味着，使用你的 API 的客户端无需检查该值是否存在，他们可以**假设该字段总会存在**，只是有时它会是默认值 `None`。

在 OpenAPI 中描述这一点的方式，是把该字段标记为**必填**，因为它总会存在。

因此，一个模型的 JSON Schema 会根据它用于**输入还是输出**而有所不同：

- 用于**输入**时，`description` **不是必填**
- 用于**输出**时，它是**必填**（并且可能为 `None`，在 JSON 中为 `null`）

### 文档中的输出模型 { #model-for-output-in-docs }

from inline_snapshot import snapshot

app = FastAPI()

security = HTTPDigest(auto_error=False)


@app.get("/users/me")
def read_current_user(
    credentials: HTTPAuthorizationCredentials | None = Security(security),
):
    if credentials is None:
        return {"msg": "Create an account first"}
    return {"scheme": credentials.scheme, "credentials": credentials.credentials}


client = TestClient(app)

        "detail": [
            {
                "type": "missing",
                "loc": ["header", "p_alias"],
                "msg": "Field required",
                "input": IsOneOf(None, IsPartialDict({"p": "hello"})),
            }
        ]
    }


@pytest.mark.parametrize(
    "path",
    [
        "/required-alias",
        "/model-required-alias",
    ],
)

 *
 */
public interface BeanConfigurationRequest {

    /**
     * Gets the bean to configure. Eventually, a valid request must have a bean set.
     *
     * @return The bean to configure, or {@code null} if none.
     */
    Object getBean();

    /**
     * Sets the bean to configure. Eventually, a valid request must have a bean set.
     *
     * @param bean The bean to configure, may be {@code null}.

app = FastAPI()


class Item(BaseModel):
    name: str
    price: float
    is_offer: bool | None = None


@app.get("/")
def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
def read_item(item_id: int, q: str | None = None):
    return {"item_id": item_id, "q": q}


@app.put("/items/{item_id}")
def update_item(item_id: int, item: Item):

app = FastAPI()


class Item(BaseModel):
    name: str
    price: float
    is_offer: bool | None = None


@app.get("/")
def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
def read_item(item_id: int, q: str | None = None):
    return {"item_id": item_id, "q": q}


@app.put("/items/{item_id}")
def update_item(item_id: int, item: Item):

函数参数按如下规则进行识别：

* 如果该参数也在**路径**中声明了，它就是路径参数。
* 如果该参数是（`int`、`float`、`str`、`bool` 等）**单一类型**，它会被当作**查询**参数。
* 如果该参数的类型声明为 **Pydantic 模型**，它会被当作请求**体**。

/// note | 注意

FastAPI 会根据默认值 `= None` 知道 `q` 的值不是必填的。

`str | None` 并不是 FastAPI 用来判断是否必填的依据；是否必填由是否有默认值 `= None` 决定。

但添加这些类型注解可以让你的编辑器提供更好的支持并检测错误。

///

## 不使用 Pydantic { #without-pydantic }