📤 💼 🌐❔ 👆 💪 💪 🔀 🏗 🗄 🔗.

👉 📄 👆 🔜 👀 ❔.

## 😐 🛠️

😐 (🔢) 🛠️, ⏩.

`FastAPI` 🈸 (👐) ✔️ `.openapi()` 👩‍🔬 👈 📈 📨 🗄 🔗.

🍕 🈸 🎚 🏗, *➡ 🛠️* `/openapi.json` (⚖️ ⚫️❔ 👆 ⚒ 👆 `openapi_url`) ®.

⚫️ 📨 🎻 📨 ⏮️ 🏁 🈸 `.openapi()` 👩‍🔬.

🔢, ⚫️❔ 👩‍🔬 `.openapi()` 🔨 ✅ 🏠 `.openapi_schema` 👀 🚥 ⚫️ ✔️ 🎚 & 📨 👫.

🚥 ⚫️ 🚫, ⚫️ 🏗 👫 ⚙️ 🚙 🔢 `fastapi.openapi.utils.get_openapi`.

A `FastAPI` application (instance) has an `.openapi()` method that is expected to return the OpenAPI schema.

As part of the application object creation, a *path operation* for `/openapi.json` (or for whatever you set your `openapi_url`) is registered.

It just returns a JSON response with the result of the application's `.openapi()` method.

第一步是禁用 API 文档，就是使用 CDN 的默认文档。

创建 `FastAPI` 应用时把文档的 URL 设置为 `None` 即可禁用默认文档：

```Python hl_lines="9"
{!../../../docs_src/extending_openapi/tutorial002.py!}
```

### 添加自定义文档

现在，创建自定义文档的*路径操作*。

导入 FastAPI 内部函数为文档创建 HTML 页面，并把所需参数传递给这些函数：

* `openapi_url`： API 文档获取 OpenAPI 概图的 HTML 页面，此处可使用 `app.openapi_url`
* `title`：API 的标题
* `oauth2_redirect_url`：此处使用 `app.swagger_ui_oauth2_redirect_url` 作为默认值

Als Teil der Erstellung des Anwendungsobjekts wird eine *Pfadoperation* für `/openapi.json` (oder welcher Wert für den Parameter `openapi_url` gesetzt wurde) registriert.

Diese gibt lediglich eine JSON-Response zurück, mit dem Ergebnis der Methode `.openapi()` der Anwendung.