Search Options

Display Count
Sort
Preferred Language
Advanced Search

Results 1 - 10 of 133 for ReDoc (0.03 seconds)

  2. github.com/tiangolo/fastapi

    docs/en/docs/img/index/index-02-redoc-simple.png 

    index-02-redoc-simple.png...
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 26 19:09:53 GMT 2020
    - 66.9K bytes
    - Click Count (0)
  3. github.com/tiangolo/fastapi

    docs/en/docs/img/index/index-06-redoc-02.png 

    index-06-redoc-02.png...
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 26 19:09:53 GMT 2020
    - 77K bytes
    - Click Count (0)
  4. 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)
  5. 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)
  6. github.com/tiangolo/fastapi

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

    For example, let's add [ReDoc's OpenAPI extension to include a custom logo](https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md#x-logo).

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

First, write all your **FastAPI** application as normally:

{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[1,4,7:9] *}
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 05 18:13:19 GMT 2026
    - 3.3K bytes
    - Click Count (0)
  7. 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)
  8. github.com/tiangolo/fastapi

    docs_src/custom_docs_ui/tutorial001_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="https://unpkg.com/redoc@2/bundles/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)
  9. github.com/tiangolo/fastapi

    docs/zh-hant/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:05:38 GMT 2026
    - 6.9K bytes
    - Click Count (0)
  10. github.com/tiangolo/fastapi

    docs/uk/docs/index.md 

    ### Альтернативна документація API { #alternative-api-docs }

А тепер перейдіть на [http://127.0.0.1:8000/redoc](http://127.0.0.1:8000/redoc).

Ви побачите альтернативну автоматичну документацію (надану [ReDoc](https://github.com/Rebilly/ReDoc)):

![ReDoc](https://fastapi.tiangolo.com/img/index/index-02-redoc-simple.png)

## Приклад оновлення { #example-upgrade }
    Created: Sun Apr 05 07:19:11 GMT 2026
    - Last Modified: Thu Mar 19 18:27:41 GMT 2026
    - 29.1K bytes
    - Click Count (0)
  11. 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)
Back to Top