# OpenAPI `docs`

Utilities to handle OpenAPI automatic UI documentation, including Swagger UI (by default at `/docs`) and ReDoc (by default at `/redoc`).

::: fastapi.openapi.docs.get_swagger_ui_html

::: fastapi.openapi.docs.get_redoc_html

::: fastapi.openapi.docs.get_swagger_ui_oauth2_redirect_html

## 透過設定與環境變數的條件式 OpenAPI { #conditional-openapi-from-settings-and-env-vars }

你可以用相同的 Pydantic 設定，來配置產生的 OpenAPI 與文件 UI。

例如：

{* ../../docs_src/conditional_openapi/tutorial001_py310.py hl[6,11] *}

這裡我們宣告 `openapi_url` 設定，預設值同樣是 `"/openapi.json"`。

接著在建立 `FastAPI` 應用時使用它。

然後你可以將環境變數 `OPENAPI_URL` 設為空字串，以停用 OpenAPI（包含文件 UI），如下：

<div class="termy">

```console
$ OPENAPI_URL= uvicorn main:app

You can see the defined cookies in the docs UI at `/docs`:

<div class="screenshot">
<img src="/img/tutorial/cookie-param-models/image01.png">
</div>

/// info

Have in mind that, as **browsers handle cookies** in special ways and behind the scenes, they **don't** easily allow **JavaScript** to touch them.

### 浏览器 UI

- 搜索 UI: http://localhost:8080/

![Search UI](https://fess.codelibs.org/_images/fess_search_result1.png)

- 管理 UI: http://localhost:8080/admin/ （默认用户名/密码为 admin/admin）

![Admin UI](https://fess.codelibs.org/_images/fess_admin_dashboard.png)

async def custom_swagger_ui_html():
    return get_swagger_ui_html(
        openapi_url=app.openapi_url,
        title=app.title + " - Swagger UI",
        oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url,
        swagger_js_url="/static/swagger-ui-bundle.js",
        swagger_css_url="/static/swagger-ui.css",
    )


@app.get(app.swagger_ui_oauth2_redirect_url, include_in_schema=False)
async def swagger_ui_redirect():

        final char[] uni = new char[slim - si];
        int ui, ch;

        for (ui = 0; si < slim && (ch = src[si++] & 0xFF) != 0; ui++) {
            if (ch < 0x80) {
                uni[ui] = (char) ch;
            } else if ((ch & 0xE0) == 0xC0) {
                if (slim - si < 2) {
                    break;
                }
                uni[ui] = (char) ((ch & 0x1F) << 6);
                ch = src[si] & 0xFF;

Тепер перейдіть на [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).

### 브라우저 UI

- 검색 UI: http://localhost:8080/

![검색 UI](https://fess.codelibs.org/_images/fess_search_result1.png)

- 관리자 UI: http://localhost:8080/admin/ (기본 사용자 이름/비밀번호는 admin/admin입니다)

![관리자 UI](https://fess.codelibs.org/_images/fess_admin_dashboard.png)

<img src="/img/tutorial/sub-applications/image02.png">

どちらの UI でも操作すれば正しく動作します。ブラウザがそれぞれのアプリ／サブアプリと通信できるためです。

### 技術詳細: `root_path` { #technical-details-root-path }

上記のようにサブアプリケーションをマウントすると、FastAPI は ASGI 仕様の `root_path` と呼ばれる仕組みを使って、そのサブアプリケーションへのマウントパスを伝播します。

このため、サブアプリケーションはドキュメント UI でそのパス接頭辞を使用すべきことを認識できます。

## ドキュメントの確認 { #check-the-docs }

対話的APIドキュメントUI `/docs` で、定義されているクッキーを確認できます:

<div class="screenshot">
<img src="/img/tutorial/cookie-param-models/image01.png">
</div>

/// info | 情報

**ブラウザがクッキーを処理し**ていますが、特別な方法で内部的に処理を行っているために、**JavaScript**からは簡単に操作**できない**ことに留意してください。

**APIドキュメントUI** `/docs` にアクセスすれば、*path operation*に関するクッキーの**ドキュメンテーション**を確認できます。