SET_OF_STR_SCHEMA = {"type": "array", "items": {"type": "string"}, "uniqueItems": True}


@pytest.fixture(
    name="mod_name",
    params=[
        pytest.param("tutorial001_py310", marks=needs_py310),
        pytest.param("tutorial002_py310", marks=needs_py310),
        pytest.param("tutorial003_py310", marks=needs_py310),
    ],
)
def get_mod_name(request: pytest.FixtureRequest):
    return request.param


@pytest.fixture(name="client")

{* ../../docs_src/server_sent_events/tutorial002_py310.py hl[4,26] *}

`data` 필드는 항상 JSON으로 인코딩됩니다. Pydantic 모델을 포함해 JSON으로 직렬화할 수 있는 값을 모두 전달할 수 있습니다.

## 원시 데이터 { #raw-data }

JSON 인코딩 없이 데이터를 보내야 한다면, `data` 대신 `raw_data`를 사용하세요.

미리 포맷된 텍스트, 로그 라인, 또는 `[DONE]`과 같은 특수한 <dfn title="특수한 조건이나 상태를 나타내는 데 사용되는 값">"센티널"</dfn> 값을 보낼 때 유용합니다.

{* ../../docs_src/server_sent_events/tutorial003_py310.py hl[17] *}

/// note | 참고

{* ../../docs_src/server_sent_events/tutorial002_py310.py hl[4,26] *}

`data` 欄位一律會以 JSON 編碼。你可以傳入任何可序列化為 JSON 的值，包括 Pydantic 模型。

## 原始資料 { #raw-data }

如果你需要在**不**進行 JSON 編碼的情況下傳送資料，請使用 `raw_data` 取代 `data`。

這對於傳送已格式化的文字、日誌行或特殊的 <dfn title="用於表示特殊條件或狀態的值">"哨兵"</dfn> 值（例如 `[DONE]`）很有用。

{* ../../docs_src/server_sent_events/tutorial003_py310.py hl[17] *}

/// note

Let's say you have a Pydantic model with default values, like this one:

{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:7] hl[7] *}

### Model for Input { #model-for-input }

If you use this model as an input like here:

{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:15] hl[14] *}

...then the `description` field will **not be required**. Because it has a default value of `None`.

## Optional parameters { #optional-parameters }

The same way, you can declare optional query parameters, by setting their default to `None`:

{* ../../docs_src/query_params/tutorial002_py310.py hl[7] *}

In this case, the function parameter `q` will be optional, and will be `None` by default.

/// check

We can instead create an input model with the plaintext password and an output model without it:

{* ../../docs_src/response_model/tutorial003_py310.py hl[9,11,16] *}

Here, even though our *path operation function* is returning the same input user that contains the password:

{* ../../docs_src/response_model/tutorial003_py310.py hl[24] *}

...we declared the `response_model` to be our model `UserOut`, that doesn't include the password:

しかし、`syntaxHighlight` を `False` に設定すると無効化できます:

{* ../../docs_src/configure_swagger_ui/tutorial001_py310.py hl[3] *}

...その場合、Swagger UI ではシンタックスハイライトが表示されなくなります:

<img src="/img/tutorial/extending-openapi/image03.png">

## テーマの変更 { #change-the-theme }

同様に、キー `"syntaxHighlight.theme"`（途中にドットが含まれている点に注意）でシンタックスハイライトのテーマを設定できます:

{* ../../docs_src/configure_swagger_ui/tutorial002_py310.py hl[3] *}

この設定により、シンタックスハイライトの配色テーマが変わります:

Let's say that you want to return an [XML](https://en.wikipedia.org/wiki/XML) response.

You could put your XML content in a string, put that in a `Response`, and return it:

{* ../../docs_src/response_directly/tutorial002_py310.py hl[1,18] *}

## How a Response Model Works { #how-a-response-model-works }

///

## 快速記住名稱 { #shortcut-to-remember-the-names }

再看一次前面的範例：

{* ../../docs_src/response_status_code/tutorial001_py310.py hl[6] *}

`201` 是「已建立（Created）」的狀態碼。

但你不需要背下每個代碼代表什麼。

你可以使用 `fastapi.status` 提供的便利變數。

{* ../../docs_src/response_status_code/tutorial002_py310.py hl[1,6] *}

它們只是方便用的常數，值與數字相同，但這樣你可以用編輯器的自動完成來找到它們：

<img src="/img/tutorial/response-status-code/image02.png">

By default, the OpenAPI schema is served at `/openapi.json`.

But you can configure it with the parameter `openapi_url`.

For example, to set it to be served at `/api/v1/openapi.json`:

{* ../../docs_src/metadata/tutorial002_py310.py hl[3] *}

If you want to disable the OpenAPI schema completely you can set `openapi_url=None`, that will also disable the documentation user interfaces that use it.

## Docs URLs { #docs-urls }