fastapi Architecture Docs
Home / File/ test_schema_ref_pydantic_v2.py — fastapi Source File

test_schema_ref_pydantic_v2.py — fastapi Source File

Architecture documentation for test_schema_ref_pydantic_v2.py, a python file in the fastapi codebase. 6 imports, 0 dependents.

File python FastAPI Routing 6 imports 3 functions 1 classes

Entity Profile

Dependency Diagram

graph LR
  571c9a79_ce50_1841_2d22_31d60e4ced6e["test_schema_ref_pydantic_v2.py"]
  0dda2280_3359_8460_301c_e98c77e78185["typing"]
  571c9a79_ce50_1841_2d22_31d60e4ced6e --> 0dda2280_3359_8460_301c_e98c77e78185
  5befe8bf_65d1_d058_6b78_4a597a8488e9["pytest"]
  571c9a79_ce50_1841_2d22_31d60e4ced6e --> 5befe8bf_65d1_d058_6b78_4a597a8488e9
  534f6e44_61b8_3c38_8b89_6934a6df9802["__init__.py"]
  571c9a79_ce50_1841_2d22_31d60e4ced6e --> 534f6e44_61b8_3c38_8b89_6934a6df9802
  a7c04dee_ee23_5891_b185_47ff6bed036d["testclient.py"]
  571c9a79_ce50_1841_2d22_31d60e4ced6e --> a7c04dee_ee23_5891_b185_47ff6bed036d
  a7f4e7b0_9725_db90_5cbc_7ca8211b323a["inline_snapshot"]
  571c9a79_ce50_1841_2d22_31d60e4ced6e --> a7f4e7b0_9725_db90_5cbc_7ca8211b323a
  6913fbd4_39df_d14b_44bb_522e99b65b90["pydantic"]
  571c9a79_ce50_1841_2d22_31d60e4ced6e --> 6913fbd4_39df_d14b_44bb_522e99b65b90
  style 571c9a79_ce50_1841_2d22_31d60e4ced6e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

from typing import Any

import pytest
from fastapi import FastAPI
from fastapi.testclient import TestClient
from inline_snapshot import snapshot
from pydantic import BaseModel, ConfigDict, Field


@pytest.fixture(name="client")
def get_client():
    app = FastAPI()

    class ModelWithRef(BaseModel):
        ref: str = Field(validation_alias="$ref", serialization_alias="$ref")
        model_config = ConfigDict(validate_by_alias=True, serialize_by_alias=True)

    @app.get("/", response_model=ModelWithRef)
    async def read_root() -> Any:
        return {"$ref": "some-ref"}

    client = TestClient(app)
    return client


def test_get(client: TestClient):
    response = client.get("/")
    assert response.json() == {"$ref": "some-ref"}


def test_openapi_schema(client: TestClient):
    response = client.get("openapi.json")
    assert response.json() == snapshot(
        {
            "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",
                                "content": {
                                    "application/json": {
                                        "schema": {
                                            "$ref": "#/components/schemas/ModelWithRef"
                                        }
                                    }
                                },
                            }
                        },
                    }
                }
            },
            "components": {
                "schemas": {
                    "ModelWithRef": {
                        "properties": {"$ref": {"type": "string", "title": "$Ref"}},
                        "type": "object",
                        "required": ["$ref"],
                        "title": "ModelWithRef",
                    }
                }
            },
        }
    )

Domain

Subdomains

Functions

Classes

Dependencies

Source

Frequently Asked Questions

What does test_schema_ref_pydantic_v2.py do?
test_schema_ref_pydantic_v2.py is a source file in the fastapi codebase, written in python. It belongs to the FastAPI domain, Routing subdomain.
What functions are defined in test_schema_ref_pydantic_v2.py?
test_schema_ref_pydantic_v2.py defines 3 function(s): get_client, test_get, test_openapi_schema.
What does test_schema_ref_pydantic_v2.py depend on?
test_schema_ref_pydantic_v2.py imports 6 module(s): __init__.py, inline_snapshot, pydantic, pytest, testclient.py, typing.
Where is test_schema_ref_pydantic_v2.py in the architecture?
test_schema_ref_pydantic_v2.py is located at tests/test_schema_ref_pydantic_v2.py (domain: FastAPI, subdomain: Routing, directory: tests).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free