# 教程 - 用户指南

本教程将一步步向您展示如何使用 **FastAPI** 的绝大部分特性。

各个章节的内容循序渐进，但是又围绕着单独的主题，所以您可以直接跳转到某个章节以解决您的特定需求。

本教程同样可以作为将来的参考手册，所以您可以随时回到本教程并查阅您需要的内容。

## 运行代码

所有代码片段都可以复制后直接使用（它们实际上是经过测试的 Python 文件）。

要运行任何示例，请将代码复制到 `main.py` 文件中，然后使用以下命令启动 `fastapi dev`：

<div class="termy">

```console
$ <font color="#4E9A06">fastapi</font> dev <u style="text-decoration-style:solid">main.py</u>

        return getPath(StringUtil.EMPTY, "js", names);
    }

    /**
     * Gets the path to environment-specific files directory.
     *
     * @param envName the environment name (e.g., "python", "ruby")
     * @param names the path components to append to the environment directory
     * @return the Path object pointing to the environment-specific directory
     */

{* ../../docs_src/body_updates/tutorial001.py hl[30,31,32,33,34,35] *}

既存のデータを置き換えるべきデータを受け取るために`PUT`は使用されます。

### 置換についての注意

つまり、`PUT`を使用して以下のボディで項目`bar`を更新したい場合は:

```Python
{
    "name": "Barz",
    "price": 3,
    "description": None,
}
```

すでに格納されている属性`"tax": 20.2`を含まないため、入力モデルのデフォルト値は`"tax": 10.5`です。

そして、データはその「新しい」`10.5`の`tax`と共に保存されます。

## `PATCH`による部分的な更新

`str`을 상속함으로써 API 문서는 값이 `string` 형이어야 하는 것을 알게 되고 이는 문서에 제대로 표시됩니다.

가능한 값들에 해당하는 고정된 값의 클래스 어트리뷰트들을 만듭니다:

{* ../../docs_src/path_params/tutorial005.py hl[1,6:9] *}

/// info | 정보

<a href="https://docs.python.org/3/library/enum.html" class="external-link" target="_blank">열거형(또는 enums)</a>은 파이썬 버전 3.4 이후로 사용 가능합니다.

///

/// tip | 팁

  --output=documents.json \
  --type=data
```

**Step 2: Convert to Fess Format**

Transform documents to include Fess required fields. Example transformation script:

```python
import json

with open('documents.json', 'r') as infile, \
     open('fess-documents.json', 'w') as outfile:
    for line in infile:
        doc = json.loads(line)

        # Transform to Fess format

#### Про `**user_dict` { #about-user-dict }

`UserInDB(**user_dict)` означает:

*Передать ключи и значения `user_dict` непосредственно как аргументы ключ-значение, эквивалентно:*

```Python
UserInDB(
    username = user_dict["username"],
    email = user_dict["email"],
    full_name = user_dict["full_name"],
    disabled = user_dict["disabled"],
    hashed_password = user_dict["hashed_password"],

### `UJSONResponse`

`UJSONResponse` 是一个使用 <a href="https://github.com/ultrajson/ultrajson" class="external-link" target="_blank">`ujson`</a> 的可选 JSON 响应。

/// warning | 警告

在处理某些边缘情况时，`ujson` 不如 Python 的内置实现那么谨慎。

///

{* ../../docs_src/custom_response/tutorial001.py hl[2,7] *}

/// tip | 小贴士

`ORJSONResponse` 可能是一个更快的选择。

///

### `RedirectResponse`

        bool,
        Doc(
            """
            Pydantic's `by_alias` parameter, passed to Pydantic models to define if
            the output should use the alias names (when provided) or the Python
            attribute names. In an API, if you set an alias, it's probably because you
            want to use it in the result, so you probably want to leave this set to
            `True`.
            """
        ),

* PostgreSQL
* MySQL
* SQLite
* Oracle
* Microsoft SQL Server, etc.

In this example, we'll use **SQLite**, because it uses a single file and Python has integrated support. So, you can copy this example and run it as is.

Later, for your production application, you might want to use a database server like **PostgreSQL**.

/// tip

* PostgreSQL
* MySQL
* SQLite
* Oracle
* Microsoft SQL Server, usw.

In diesem Beispiel verwenden wir **SQLite**, da es eine einzelne Datei verwendet und Python integrierte Unterstützung bietet. Sie können also dieses Beispiel kopieren und direkt ausführen.

Später, für Ihre Produktionsanwendung, möchten Sie möglicherweise einen Datenbankserver wie **PostgreSQL** verwenden.