client = TestClient(app)


def test_get():
    response = client.get("/users/rick")
    assert response.status_code == 200, response.text
    assert response.json() == {"user_id": "rick", "path": "/users/{user_id}"}


def test_invalid_method_doesnt_match():
    response = client.post("/users/rick")
    assert response.status_code == 405, response.text

### [Pydantic](https://docs.pydantic.dev/) { #pydantic }

Pydantic 是基於 Python 型別提示，定義資料驗證、序列化與文件（使用 JSON Schema）的函式庫。

這讓它非常直覺。

它可與 Marshmallow 相提並論。儘管在效能測試中它比 Marshmallow 更快。而且因為它基於相同的 Python 型別提示，編輯器支援也很出色。

/// check | **FastAPI** 用於

處理所有資料驗證、資料序列化與自動模型文件（基於 JSON Schema）。

**FastAPI** 接著會把這些 JSON Schema 資料放入 OpenAPI 中，此外還有其他許多功能。

///

### [Starlette](https://www.starlette.dev/) { #starlette }

/.settings/
.project
.classpath
*.iml
.idea
.vscode
.DS_Store
/plugins/
/modules/
/tomcat.8080/
dbflute_fess/output/doc/lastadoc-fess.html
dbflute_fess/schema/project-lastadoc-fess.json
src/main/resources/fess_indices/fess_config.access_token/access_token.bulk
src/main/resources/ga_client_secrets.p12
src/main/webapp/WEB-INF/project.properties
/.apt_generated/
/.apt_generated_tests/
/.serena

import org.gradle.api.tasks.Input;

/**
 * A single instruction to transforms a REST test.
 */
public interface RestTestTransform<T extends JsonNode> extends Named {

    /**
     * Transform the Json structure per the given {@link RestTestTransform}
     * Implementations are expected to mutate the parent to satisfy the transformation.
     *
     * @param parent The parent of the node to transform.
     */

## URL для OpenAPI { #openapi-url }

За замовчуванням схема OpenAPI надається за адресою `/openapi.json`.

Але Ви можете налаштувати це за допомогою параметра `openapi_url`.

Наприклад, щоб налаштувати його на `/api/v1/openapi.json`:

{* ../../docs_src/metadata/tutorial002_py310.py hl[3] *}

        if (typeObj != null) {
            final String path = "suggest_indices/_" + typeObj.toString() + "/suggest_analyzer.json";
            if (ResourceUtil.getResourceNoException(path) != null) {
                return path;
            }
        }
        return "suggest_indices/suggest_analyzer.json";
    }

    /**
     * Loads the index mapping from a resource file.
     * @return The index mapping as a string.

              <resources>
                <resource>
                  <directory>.</directory>
                  <includes>
                    <include>module.json</include>
                  </includes>
                  <filtering>true</filtering>
                </resource>
              </resources>
            </configuration>
          </execution>

// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

package openid

import (
	"bytes"
	"encoding/base64"
	"encoding/json"
	"fmt"
	"io"
	"net/http"
	"net/http/httptest"
	"net/url"
	"sync"
	"testing"
	"time"

	jwtgo "github.com/golang-jwt/jwt/v4"
	"github.com/minio/minio/internal/arn"

	<component name="chatApiManager" class="org.codelibs.fess.api.chat.ChatApiManager">
	</component>

	<component name="searchApiManager" class="org.codelibs.fess.api.json.SearchApiManager">
	</component>
	<component name="searchEngineApiManager" class="org.codelibs.fess.api.engine.SearchEngineApiManager">
	</component>

FastAPI 會使用這個回傳型別來：

* 驗證回傳的資料。
    * 如果資料無效（例如缺少欄位），代表你的應用程式程式碼有問題，沒有回傳應該回傳的內容，FastAPI 會回傳伺服器錯誤，而不是回傳不正確的資料。如此你和你的用戶端都能確定會收到預期的資料與資料結構。
* 在 OpenAPI 的「路徑操作」中為回應新增 JSON Schema。
    * 這會被自動文件使用。
    * 也會被自動用戶端程式碼產生工具使用。
* 使用 Pydantic 將回傳資料**序列化**為 JSON，而 Pydantic 是用 **Rust** 撰寫的，因此會 **更快很多**。

但更重要的是：

* 它會將輸出資料限制並過濾為回傳型別中定義的內容。
    * 這對安全性特別重要，下面會再看到更多細節。

## `response_model` 參數 { #response-model-parameter }