Here are several ways to do it.

## Extra JSON Schema data in Pydantic models { #extra-json-schema-data-in-pydantic-models }

You can declare `examples` for a Pydantic model that will be added to the generated JSON Schema.

{* ../../docs_src/schema_extra_example/tutorial001_py310.py hl[13:24] *}

That extra info will be added as-is to the output **JSON Schema** for that model, and it will be used in the API docs.

## ドキュメントを見る { #see-it-in-the-docs }

自動ドキュメントを見ると、入力モデルと出力モデルがそれぞれ独自のJSON Schemaを持っていることが確認できます:

<img src="/img/tutorial/response-model/image01.png">

そして、両方のモデルは対話型のAPIドキュメントに使用されます:

<img src="/img/tutorial/response-model/image02.png">

## その他の戻り値の型アノテーション { #other-return-type-annotations }

Pydanticフィールドとして有効ではないものを返し、ツール（エディタやmypyなど）が提供するサポートを得るためだけに、関数でそれをアノテーションするケースがあるかもしれません。

如此，你就能同時擁有兩種好處：具備工具支援的型別註解，以及資料過濾。

## 在文件中查看 { #see-it-in-the-docs }

在自動文件中，你可以看到輸入模型與輸出模型各自都有自己的 JSON Schema：

<img src="/img/tutorial/response-model/image01.png">

而且兩個模型都會用在互動式 API 文件中：

<img src="/img/tutorial/response-model/image02.png">

## 其他回傳型別註解 { #other-return-type-annotations }

有時你回傳的東西不是有效的 Pydantic 欄位，你仍會在函式上加上註解，只為了獲得工具（編輯器、mypy 等）提供的支援。

        </executions>
      </plugin>
      <plugin>
        <groupId>org.codehaus.modello</groupId>
        <artifactId>modello-maven-plugin</artifactId>
        <configuration>
          <version>1.2.0</version>
          <models>
            <model>../../api/maven-api-cli/src/main/mdo/core-extensions.mdo</model>
          </models>
          <templates>
            <template>reader-stax.vm</template>

その動作と、必要に応じての変更方法を見ていきます。

## 入出力のPydanticモデル { #pydantic-models-for-input-and-output }

次のようにデフォルト値を持つ Pydantic モデルがあるとします。

{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:7] hl[7] *}

### 入力用モデル { #model-for-input }

このモデルを次のように入力として使うと:

{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:15] hl[14] *}

        }

        return false;
    }

    /**
     * Checks if a model version is eligible for inference optimizations.
     * Models 4.0.0+ are eligible (4.0.0 has limited inference, 4.1.0+ has full inference).
     *
     * @param modelVersion the model version to check
     * @return true if eligible for inference
     */

# Module mockwebserver

# Module okhttp-sse

/**
 * A test which demonstrates maven's recursive inheritance where
 * a distinct value is taken from each parent contributing to
 * the final model of the project being assembled. There is no
 * overriding going on amongst the models being used in this test:
 * each model in the lineage is providing a value that is not present
 * anywhere else in the lineage. We are just making sure that values

import binascii
from base64 import b64decode
from typing import Annotated

from annotated_doc import Doc
from fastapi.exceptions import HTTPException
from fastapi.openapi.models import HTTPBase as HTTPBaseModel
from fastapi.openapi.models import HTTPBearer as HTTPBearerModel
from fastapi.security.base import SecurityBase
from fastapi.security.utils import get_authorization_scheme_param
from pydantic import BaseModel
from starlette.requests import Request