from fastapi import FastAPI, Query

app = FastAPI()


@app.get("/items/")
async def read_items(
    hidden_query: str | None = Query(default=None, include_in_schema=False),
):
    if hidden_query:
        return {"hidden_query": hidden_query}
    else:

<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 typing import Annotated

from fastapi import FastAPI, Query

app = FastAPI()


@app.get("/items/")
async def read_items(
    hidden_query: Annotated[str | None, Query(include_in_schema=False)] = None,
):
    if hidden_query:
        return {"hidden_query": hidden_query}
    else:

from fastapi import FastAPI, Query

app = FastAPI()


@app.get("/items/")
async def read_items(q: str | None = Query(default=None, alias="item-query")):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})

            ),
        ],
        scheme_name: Annotated[
            str | None,
            Doc(
                """
                Security scheme name.

                It will be included in the generated OpenAPI (e.g. visible at `/docs`).
                """
            ),
        ] = None,
        description: Annotated[
            str | None,
            Doc(
                """

from fastapi import FastAPI, Query

app = FastAPI()


@app.get("/items/")
async def read_items(
    q: str | None = Query(
        default=None, min_length=3, max_length=50, pattern="^fixedquery$"
    ),
):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})

        BuildResult result = runner.buildAndFail();
        assertOutputContains(
            result.getOutput(),
            "Expected at least one test class included in task :empty_test_task:emptyTest, but found none.",
            "Expected at least one test class included in task :empty_test_task:test, but found none."
        );
    }

    public void testAllTestTasksIncluded() {

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)

from typing import Annotated

from fastapi import FastAPI, Query

app = FastAPI()


@app.get("/items/")
async def read_items(
    q: Annotated[str | None, Query(title="Query string", min_length=3)] = None,
):
    results = {"items": [{"item_id": "Foo"}, {"item_id": "Bar"}]}
    if q:
        results.update({"q": q})