You can reuse FastAPI's internal functions to create the HTML pages for the docs, and pass them the needed arguments:

* `openapi_url`: the URL where the HTML page for the docs can get the OpenAPI schema for your API. You can use here the attribute `app.openapi_url`.
* `title`: the title of your API.
* `oauth2_redirect_url`: you can use `app.swagger_ui_oauth2_redirect_url` here to use the default.

By default, the OpenAPI schema is served at `/openapi.json`.

But you can configure it with the parameter `openapi_url`.

For example, to set it to be served at `/api/v1/openapi.json`:

{* ../../docs_src/metadata/tutorial002_py310.py hl[3] *}

If you want to disable the OpenAPI schema completely you can set `openapi_url=None`, that will also disable the documentation user interfaces that use it.

## Docs URLs { #docs-urls }

### 加入自訂文件 { #include-the-custom-docs }

現在你可以為自訂文件建立「路徑操作（path operation）」。

你可以重用 FastAPI 的內部函式來建立文件的 HTML 頁面，並傳入所需參數：

* `openapi_url`：文件 HTML 頁面用來取得你 API 的 OpenAPI schema 的 URL。可使用屬性 `app.openapi_url`。
* `title`：你的 API 標題。
* `oauth2_redirect_url`：可使用 `app.swagger_ui_oauth2_redirect_url` 以沿用預設值。
* `swagger_js_url`：Swagger UI 文件 HTML 用來取得「JavaScript」檔案的 URL。這是你的自訂 CDN 位址。

## OpenAPI URL { #openapi-url }

默认情况下，OpenAPI 模式服务于 `/openapi.json`。

但是你可以通过参数 `openapi_url` 对其进行配置。

例如，将其设置为服务于 `/api/v1/openapi.json`：

{* ../../docs_src/metadata/tutorial002_py310.py hl[3] *}

如果你想完全禁用 OpenAPI 模式，可以将其设置为 `openapi_url=None`，这样也会禁用使用它的文档用户界面。

## 文档 URLs { #docs-urls }

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

- **Swagger UI**：服务于 `/docs`。

## OpenAPI URL { #openapi-url }

기본적으로 OpenAPI 스키마는 `/openapi.json`에서 제공됩니다.

하지만 `openapi_url` 매개변수로 이를 설정할 수 있습니다.

예를 들어, 이를 `/api/v1/openapi.json`에서 제공하도록 설정하려면:

{* ../../docs_src/metadata/tutorial002_py310.py hl[3] *}

OpenAPI 스키마를 완전히 비활성화하려면 `openapi_url=None`으로 설정할 수 있으며, 이를 사용하여 문서화 사용자 인터페이스도 비활성화됩니다.

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

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

## OpenAPI URL { #openapi-url }

預設情況下，OpenAPI 綱要（schema）會提供在 `/openapi.json`。

但你可以用 `openapi_url` 參數來調整。

例如，將它設定為提供在 `/api/v1/openapi.json`：

{* ../../docs_src/metadata/tutorial002_py310.py hl[3] *}

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

## 文件 URL { #docs-urls }

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

* Swagger UI：提供於 `/docs`。

## OpenAPI URL { #openapi-url }

デフォルトでは、OpenAPIスキーマは `/openapi.json` で提供されます。

ただし、パラメータ `openapi_url` を使用して設定を変更できます。

たとえば、`/api/v1/openapi.json` で提供されるように設定するには:

{* ../../docs_src/metadata/tutorial002_py310.py hl[3] *}

OpenAPIスキーマを完全に無効にする場合は、`openapi_url=None` を設定できます。これにより、それを使用するドキュメントUIも無効になります。

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

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

### カスタムドキュメントの追加 { #include-the-custom-docs }

これで、カスタムドキュメント用の *path operations* を作成できます。

FastAPI の内部関数を再利用してドキュメント用の HTML ページを生成し、必要な引数を渡せます:

- `openapi_url`: ドキュメントの HTML ページが API の OpenAPI スキーマを取得する URL。ここでは属性 `app.openapi_url` を使用できます。
- `title`: API のタイトル。
- `oauth2_redirect_url`: 既定値を使うにはここで `app.swagger_ui_oauth2_redirect_url` を使用できます。

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.

{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[8] *}

### 包含自定义文档 { #include-the-custom-docs }

现在你可以为自定义文档创建*路径操作*。

你可以复用 FastAPI 的内部函数来创建文档的 HTML 页面，并传入所需参数：

- `openapi_url`：文档 HTML 页面获取你的 API 的 OpenAPI 模式的 URL。这里可以使用 `app.openapi_url` 属性。
- `title`：你的 API 标题。
- `oauth2_redirect_url`：这里可以使用 `app.swagger_ui_oauth2_redirect_url` 来使用默认值。
- `swagger_js_url`：你的 Swagger UI 文档 HTML 获取**JavaScript** 文件的 URL。这里是自定义的 CDN URL。