truedoc - Code Search

docs/pt/docs/how-to/extending-openapi.md

Com as informações acima, você pode usar a mesma função utilitária para gerar o esquema OpenAPI e sobrescrever cada parte que precisar.

Por exemplo, vamos adicionar [Extensão OpenAPI do ReDoc para incluir um logo personalizado](https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md#x-logo).

### **FastAPI** Normal { #normal-fastapi }

Primeiro, escreva toda a sua aplicação **FastAPI** normalmente:

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Thu Mar 19 18:20:43 GMT 2026

- 3.5K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/zh-hant/docs/how-to/extending-openapi.md

`summary` 參數在 OpenAPI 3.1.0 以上可用，且需 FastAPI 0.99.0 以上版本支援。

///

## 覆寫預設行為 { #overriding-the-defaults }

基於上述資訊，你可以用相同的工具函式來產生 OpenAPI 結構，並覆寫你需要客製的部分。

例如，我們要加入 [ReDoc 的 OpenAPI 擴充，插入自訂 logo](https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md#x-logo)。

### 一般的 **FastAPI** { #normal-fastapi }

先照常撰寫你的 **FastAPI** 應用：

{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[1,4,7:9] *}

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Fri Mar 20 17:05:38 GMT 2026

- 3K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/fr/docs/how-to/custom-docs-ui-assets.md

Et **ReDoc** utilise le fichier :

- [`redoc.standalone.js`](https://cdn.jsdelivr.net/npm/redoc@2/bundles/redoc.standalone.js)

Après cela, votre structure de fichiers pourrait ressembler à :

```
.
├── app
│   ├── __init__.py
│   ├── main.py
└── static
    ├── redoc.standalone.js
    ├── swagger-ui-bundle.js
    └── swagger-ui.css
```

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Thu Mar 19 18:37:13 GMT 2026

- 8.7K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/zh/docs/how-to/custom-docs-ui-assets.md

- [`swagger-ui.css`](https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css)

而 ReDoc 使用以下文件：

- [`redoc.standalone.js`](https://cdn.jsdelivr.net/npm/redoc@2/bundles/redoc.standalone.js)

之后，你的文件结构可能如下：

```
.
├── app
│   ├── __init__.py
│   ├── main.py
└── static
    ├── redoc.standalone.js
    ├── swagger-ui-bundle.js
    └── swagger-ui.css
```

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Fri Mar 20 17:06:37 GMT 2026

- 7.1K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/zh/docs/how-to/extending-openapi.md

参数 `summary` 仅在 OpenAPI 3.1.0 及更高版本中可用，FastAPI 0.99.0 及以上版本支持。

///

## 覆盖默认值 { #overriding-the-defaults }

基于以上信息，你可以用同一个工具函数生成 OpenAPI 架构，并按需覆盖其中的各个部分。

例如，让我们添加 [ReDoc 的 OpenAPI 扩展以包含自定义 Logo](https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md#x-logo)。

### 常规 **FastAPI** { #normal-fastapi }

首先，像平常一样编写你的 **FastAPI** 应用：

{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[1,4,7:9] *}

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Fri Mar 20 17:06:37 GMT 2026

- 3K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/uk/docs/how-to/custom-docs-ui-assets.md

А **ReDoc** використовує файл:

- [`redoc.standalone.js`](https://cdn.jsdelivr.net/npm/redoc@2/bundles/redoc.standalone.js)

Після цього ваша структура файлів може виглядати так:

```
.
├── app
│   ├── __init__.py
│   ├── main.py
└── static
    ├── redoc.standalone.js
    ├── swagger-ui-bundle.js
    └── swagger-ui.css
```

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Thu Mar 19 18:27:41 GMT 2026

- 11.8K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/ko/docs/how-to/custom-docs-ui-assets.md

* [`swagger-ui.css`](https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css)

**ReDoc**은 다음 파일을 사용합니다:

* [`redoc.standalone.js`](https://cdn.jsdelivr.net/npm/redoc@2/bundles/redoc.standalone.js)

이후 파일 구조는 다음과 같을 수 있습니다:

```
.
├── app
│   ├── __init__.py
│   ├── main.py
└── static
    ├── redoc.standalone.js
    ├── swagger-ui-bundle.js
    └── swagger-ui.css
```

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Fri Mar 20 14:06:26 GMT 2026

- 8.9K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/ja/docs/how-to/extending-openapi.md

///

## デフォルトの上書き { #overriding-the-defaults }

上記の情報を使って、同じユーティリティ関数で OpenAPI スキーマを生成し、必要な部分を上書きできます。

たとえば、[カスタムロゴを含めるための ReDoc の OpenAPI 拡張](https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md#x-logo)を追加してみましょう。

### 通常の **FastAPI** { #normal-fastapi }

まず、通常どおりに **FastAPI** アプリケーションを実装します:

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Fri Mar 20 14:07:17 GMT 2026

- 3.9K bytes

- Click Count (0)

github.com/tiangolo/fastapi

fastapi/openapi/docs.py

    <!--
    ReDoc doesn't change outer page styles
    -->
    <style>
      body {{
        margin: 0;
        padding: 0;
      }}
    </style>
    </head>
    <body>
    <noscript>
        ReDoc requires Javascript to function. Please enable it to browse the documentation.
    </noscript>
    <redoc spec-url="{openapi_url}"></redoc>
    <script src="{redoc_js_url}"> </script>

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Tue Feb 24 09:28:10 GMT 2026

- 12.1K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs_src/custom_docs_ui/tutorial002_py310.py

async def swagger_ui_redirect():
    return get_swagger_ui_oauth2_redirect_html()


@app.get("/redoc", include_in_schema=False)
async def redoc_html():
    return get_redoc_html(
        openapi_url=app.openapi_url,
        title=app.title + " - ReDoc",
        redoc_js_url="/static/redoc.standalone.js",
    )


@app.get("/users/{username}")
async def read_user(username: str):

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Thu Feb 12 13:19:43 GMT 2026

- 1.1K bytes

- Click Count (0)

Search Options