Adopt and use an open standard for API specifications, instead of a custom schema.

And integrate standards-based user interface tools:

* [Swagger UI](https://github.com/swagger-api/swagger-ui)
* [ReDoc](https://github.com/Rebilly/ReDoc)

These two were chosen for being fairly popular and stable, but doing a quick search, you could find dozens of alternative user interfaces for OpenAPI (that you can use with **FastAPI**).

///

  url: https://github.com/LorhanSohaky
black-redoc:
  login: black-redoc
  count: 29
  avatarUrl: https://avatars.githubusercontent.com/u/18581590?u=7b6336166d0797fbbd44ea70c1c3ecadfc89af9e&v=4
  url: https://github.com/black-redoc
pedabraham:
  login: pedabraham
  count: 28

因此，談到 2.0 版時常說「Swagger」，而 3+ 版則是「OpenAPI」。

/// check | 啟發 **FastAPI**

採用並使用開放的 API 規格標準，而非自訂格式。

並整合基於標準的使用者介面工具：

* [Swagger UI](https://github.com/swagger-api/swagger-ui)
* [ReDoc](https://github.com/Rebilly/ReDoc)

選擇這兩個是因為它們相當受歡迎且穩定，但稍加搜尋，你會發現有數十種 OpenAPI 的替代使用者介面（都能與 **FastAPI** 一起使用）。

///

### Flask 的 REST 框架 { #flask-rest-frameworks }

Використовуючи наведене вище, ви можете скористатися тією ж утилітарною функцією для генерації схеми OpenAPI і переписати потрібні частини.

Наприклад, додаймо [розширення OpenAPI ReDoc для додавання власного логотипа](https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md#x-logo).

### Звичайний **FastAPI** { #normal-fastapi }

Спочатку напишіть ваш застосунок **FastAPI** як зазвичай:

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

**ReDoc** ise şu dosyayı kullanır:

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

Bundan sonra dosya yapınız şöyle görünebilir:

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

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:

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
```

参数 `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] *}

А **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
```

///

## 기본값 덮어쓰기 { #overriding-the-defaults }

위 정보를 바탕으로, 동일한 유틸리티 함수를 사용해 OpenAPI 스키마를 생성하고 필요한 각 부분을 덮어쓸 수 있습니다.

예를 들어, [커스텀 로고를 포함하기 위한 ReDoc의 OpenAPI 확장](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] *}