Now go to [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs).

You will see the automatic interactive API documentation (provided by [Swagger UI](https://github.com/swagger-api/swagger-ui)):

![Swagger UI](https://fastapi.tiangolo.com/img/index/index-01-swagger-ui-simple.png)

### Alternative API docs { #alternative-api-docs }

And now, go to [http://127.0.0.1:8000/redoc](http://127.0.0.1:8000/redoc).

Sie werden die automatisch erzeugte, interaktive API-Dokumentation sehen (bereitgestellt durch [Swagger UI](https://github.com/swagger-api/swagger-ui)):

![Swagger UI](https://fastapi.tiangolo.com/img/index/index-01-swagger-ui-simple.png)

### Alternative API-Dokumentation { #alternative-api-docs }

Gehen Sie nun auf [http://127.0.0.1:8000/redoc](http://127.0.0.1:8000/redoc).

```

### 対話的APIドキュメント { #interactive-api-docs }

次に、[http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs)にアクセスします。

自動生成された対話的APIドキュメントが表示されます（[Swagger UI](https://github.com/swagger-api/swagger-ui)で提供）:

![Swagger UI](https://fastapi.tiangolo.com/img/index/index-01-swagger-ui-simple.png)

### 代替APIドキュメント { #alternative-api-docs }

次に、[http://127.0.0.1:8000/redoc](http://127.0.0.1:8000/redoc)にアクセスします。

{"message": "Hello World"}
```

### 交互式 API 文档 { #interactive-api-docs }

跳转到 [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs)。

你将会看到自动生成的交互式 API 文档（由 [Swagger UI](https://github.com/swagger-api/swagger-ui) 提供）：

![Swagger UI](https://fastapi.tiangolo.com/img/index/index-01-swagger-ui-simple.png)

### 可选的 API 文档 { #alternative-api-docs }

前往 [http://127.0.0.1:8000/redoc](http://127.0.0.1:8000/redoc)。

## 문서화 URL { #docs-urls }

포함된 두 가지 문서화 사용자 인터페이스를 설정할 수 있습니다:

* **Swagger UI**: `/docs`에서 제공됩니다.
    * `docs_url` 매개변수로 URL을 설정할 수 있습니다.
    * `docs_url=None`으로 설정하여 비활성화할 수 있습니다.
* **ReDoc**: `/redoc`에서 제공됩니다.
    * `redoc_url` 매개변수로 URL을 설정할 수 있습니다.
    * `redoc_url=None`으로 설정하여 비활성화할 수 있습니다.

예를 들어, Swagger UI를 `/documentation`에서 제공하고 ReDoc을 비활성화하려면:

## ドキュメントのURL { #docs-urls }

含まれている2つのドキュメントUIを設定できます:

* **Swagger UI**: `/docs` で提供されます。
    * URL はパラメータ `docs_url` で設定できます。
    * `docs_url=None` を設定することで無効にできます。
* **ReDoc**: `/redoc` で提供されます。
    * URL はパラメータ `redoc_url` で設定できます。
    * `redoc_url=None` を設定することで無効にできます。

たとえば、`/documentation` でSwagger UIが提供されるように設定し、ReDocを無効にするには:

* **Swagger UI**: served at `/docs`.
    * You can set its URL with the parameter `docs_url`.
    * You can disable it by setting `docs_url=None`.
* **ReDoc**: served at `/redoc`.
    * You can set its URL with the parameter `redoc_url`.
    * You can disable it by setting `redoc_url=None`.

For example, to set Swagger UI to be served at `/documentation` and disable ReDoc:

## 文档 URLs { #docs-urls }

你可以配置两个文档用户界面，包括：

- **Swagger UI**：服务于 `/docs`。
    - 可以使用参数 `docs_url` 设置它的 URL。
    - 可以通过设置 `docs_url=None` 禁用它。
- **ReDoc**：服务于 `/redoc`。
    - 可以使用参数 `redoc_url` 设置它的 URL。
    - 可以通过设置 `redoc_url=None` 禁用它。

例如，设置 Swagger UI 服务于 `/documentation` 并禁用 ReDoc：

如果你想完全停用 OpenAPI 綱要，可以設定 `openapi_url=None`，同時也會停用依賴它的文件使用者介面。

## 文件 URL { #docs-urls }

你可以設定內建的兩個文件使用者介面：

* Swagger UI：提供於 `/docs`。
    * 可用 `docs_url` 參數設定其 URL。
    * 設定 `docs_url=None` 可停用。
* ReDoc：提供於 `/redoc`。
    * 可用 `redoc_url` 參數設定其 URL。
    * 設定 `redoc_url=None` 可停用。

例如，將 Swagger UI 提供於 `/documentation`，並停用 ReDoc：

        dict[str, Example] | None,
        Doc(
            """
            OpenAPI-specific examples.

            It will be added to the generated OpenAPI (e.g. visible at `/docs`).

            Swagger UI (that provides the `/docs` interface) has better support for the
            OpenAPI-specific examples than the JSON Schema `examples`, that's the main
            use case for this.

            Read more about it in the