有些情況你可能需要修改自動產生的 OpenAPI 結構（schema）。

本章將示範如何做。

## 一般流程 { #the-normal-process }

一般（預設）的流程如下。

`FastAPI` 應用程式（實例）有一個 `.openapi()` 方法，會回傳 OpenAPI 結構。

在建立應用物件時，會同時註冊一個 `/openapi.json`（或你在 `openapi_url` 設定的路徑）的路徑操作（path operation）。

這個路徑只會回傳一個 JSON 回應，內容就是應用的 `.openapi()` 方法結果。

預設情況下，`.openapi()` 會先檢查 `.openapi_schema` 屬性是否已有內容，有的話就直接回傳。

若沒有，則會呼叫 `fastapi.openapi.utils.get_openapi` 這個工具函式來產生。

このセクションではその方法を説明します。

## 通常のプロセス { #the-normal-process }

通常（デフォルト）のプロセスは次のとおりです。

`FastAPI` アプリケーション（インスタンス）には、OpenAPI スキーマを返すことが期待される `.openapi()` メソッドがあります。

アプリケーションオブジェクトの作成時に、`/openapi.json`（または `openapi_url` に設定したパス）への path operation が登録されます。

これは単に、アプリケーションの `.openapi()` メソッドの結果を含む JSON レスポンスを返します。

デフォルトでは、`.openapi()` メソッドはプロパティ `.openapi_schema` に内容があるかを確認し、あればそれを返します。

                )
        if self.openapi_url and self.redoc_url:

            async def redoc_html(req: Request) -> HTMLResponse:
                root_path = req.scope.get("root_path", "").rstrip("/")
                openapi_url = root_path + self.openapi_url
                return get_redoc_html(
                    openapi_url=openapi_url, title=f"{self.title} - ReDoc"
                )

    html = get_redoc_html(openapi_url="/docs", title="title")
    body_content = html.body.decode()
    assert redoc_js_url in body_content
    assert redoc_favicon_url in body_content


def test_strings_in_custom_redoc():
    redoc_js_url = "fake_redoc_file.js"
    redoc_favicon_url = "fake_redoc_file.png"
    html = get_redoc_html(
        openapi_url="/docs",
        title="title",

Тут ми оголошуємо налаштування `openapi_url` з тим самим значенням за замовчуванням `"/openapi.json"`.

Потім ми використовуємо його під час створення застосунку `FastAPI`.

Далі ви можете вимкнути OpenAPI (включно з інтерфейсами документації), встановивши змінну оточення `OPENAPI_URL` у пусту строку, наприклад:

<div class="termy">

```console
$ OPENAPI_URL= uvicorn main:app

Burada `openapi_url` ayarını, varsayılanı `"/openapi.json"` olacak şekilde tanımlıyoruz.

Ardından `FastAPI` app'ini oluştururken bunu kullanıyoruz.

Sonrasında, environment variable `OPENAPI_URL`'i boş string olarak ayarlayarak OpenAPI'yi (UI docs dahil) devre dışı bırakabilirsiniz; örneğin:

<div class="termy">

```console
$ OPENAPI_URL= uvicorn main:app

Здесь мы объявляем настройку `openapi_url` с тем же значением по умолчанию — `"/openapi.json"`.

Затем используем её при создании приложения FastAPI.

Далее вы можете отключить OpenAPI (включая интерфейсы документации), установив переменную окружения `OPENAPI_URL` в пустую строку, например:

<div class="termy">

```console
$ OPENAPI_URL= uvicorn main:app

Aquí declaramos la configuración `openapi_url` con el mismo valor por defecto de `"/openapi.json"`.

Y luego la usamos al crear la app de `FastAPI`.

Entonces podrías desactivar OpenAPI (incluyendo las UI de documentación) configurando la variable de entorno `OPENAPI_URL` a una string vacía, así:

<div class="termy">

```console
$ OPENAPI_URL= uvicorn main:app

Aqui declaramos a configuração `openapi_url` com o mesmo padrão de `"/openapi.json"`.

E então a usamos ao criar a aplicação `FastAPI`.

Então você pode desabilitar o OpenAPI (incluindo a documentação da interface do usuário) definindo a variável de ambiente `OPENAPI_URL` como a string vazia, como:

<div class="termy">

```console
$ OPENAPI_URL= uvicorn main:app

Hier deklarieren wir die Einstellung `openapi_url` mit dem gleichen Defaultwert `"/openapi.json"`.

Und dann verwenden wir es beim Erstellen der `FastAPI`-App.

Dann könnten Sie OpenAPI (einschließlich der Dokumentationsoberflächen) deaktivieren, indem Sie die Umgebungsvariable `OPENAPI_URL` auf einen leeren String setzen, wie zum Beispiel:

<div class="termy">

```console
$ OPENAPI_URL= uvicorn main:app