`get_openapi()` 函式會接收以下參數：

* `title`：OpenAPI 的標題，會顯示在文件中。
* `version`：你的 API 版本，例如 `2.5.0`。
* `openapi_version`：所使用的 OpenAPI 規格版本。預設為最新版本：`3.1.0`。
* `summary`：API 的簡短摘要。
* `description`：API 的描述，可包含 Markdown，會顯示在文件中。
* `routes`：路由列表，也就是所有已註冊的路徑操作。來源為 `app.routes`。

/// info

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

///

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

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

## Users

You will be able to:

* **Create users** (_not implemented_).
* **Read users** (_not implemented_).
"""

app = FastAPI(
    title="ChimichangApp",
    description=description,
    summary="Deadpool's favorite app. Nuff said.",
    version="0.0.1",
    terms_of_service="http://example.com/terms/",
    contact={
        "name": "Deadpoolio the Amazing",
        "url": "http://x-force.example.com/contact/",

## ドキュメントの概要と説明 - OpenAPI { #documentation-summary-and-description-openapi }

*path operations* に概要と説明を追加し、ドキュメント UI に表示するには、[チュートリアル - path operation の設定 - 概要と説明](../tutorial/path-operation-configuration.md#summary-and-description) を参照してください。

## ドキュメントのレスポンス説明 - OpenAPI { #documentation-response-description-openapi }

/*
 [Log Notification]
*/
subject: [FESS] /*pmb.level*/ Log Alert: /*pmb.hostname*/
>>>
--- Server Info ---
Host Name: /*pmb.hostname:orElse('Unknown')*/

--- Log Summary ---
Level: /*pmb.level*/
Total: /*pmb.count*/ event(s) in the last /*pmb.interval*/ seconds

--- Log Details ---
/*pmb.details*/

                                "content": {"application/json": {"schema": {}}},
                            }
                        },
                        "summary": "Read Current User",
                        "operationId": "read_current_user_users_me_get",
                        "security": [{"HTTPBase": []}],
                    }
                }
            },

## Submitting PRs

1. **Title and Summary**:
   - Use a scannable title: `[Subsystem] Action Description #Issue` (e.g., `[IAM] Add role-based access control #567`).
   - Include context in the summary: what changed, why, and any issue references.
   - Use `[WIP]` for in-progress PRs to avoid premature merging or choose GitHub draft PRs.

To solve that, FastAPI `0.103.0` **added support** for declaring the same old **OpenAPI-specific** `examples` field with the new parameter `openapi_examples`. 🤓

### Summary { #summary }

I used to say I didn't like history that much... and look at me now giving "tech history" lessons. 😅

     *
     * @param events the list of log notification events
     * @param maxDetailsLength the maximum length of the details string
     * @param maxDisplayEvents the maximum number of events to display
     * @param maxMessageLength the maximum length of each log message
     * @return the formatted details string with summary header and truncated entries
     */

        {
            "openapi": "3.1.0",
            "info": {"title": "FastAPI", "version": "0.1.0"},
            "paths": {
                "/": {
                    "get": {
                        "summary": "Read Root",
                        "operationId": "read_root__get",
                        "responses": {
                            "200": {
                                "description": "Successful Response",

- `version`: API のバージョン。例: `2.5.0`。
- `openapi_version`: 使用する OpenAPI 仕様のバージョン。デフォルトは最新の `3.1.0`。
- `summary`: API の短い概要。
- `description`: API の説明。Markdown を含めることができ、ドキュメントに表示されます。
- `routes`: ルートのリスト。登録済みの各 path operation です。`app.routes` から取得されます。

/// info | 情報

パラメータ `summary` は OpenAPI 3.1.0 以降で利用可能で、FastAPI 0.99.0 以降が対応しています。

///

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