Sync fastapi docs from b5ca1324 on 2025-12-07

tests/test_tutorial/test_behind_a_proxy/test_tutorial001.py

@@ -0,0 +1,35 @@
+from fastapi.testclient import TestClient
+
+from docs_src.behind_a_proxy.tutorial001 import app
+
+client = TestClient(app, root_path="/api/v1")
+
+
+def test_main():
+    response = client.get("/app")
+    assert response.status_code == 200
+    assert response.json() == {"message": "Hello World", "root_path": "/api/v1"}
+
+
+def test_openapi():
+    response = client.get("/openapi.json")
+    assert response.status_code == 200
+    assert response.json() == {
+        "openapi": "3.1.0",
+        "info": {"title": "FastAPI", "version": "0.1.0"},
+        "paths": {
+            "/app": {
+                "get": {
+                    "summary": "Read Main",
+                    "operationId": "read_main_app_get",
+                    "responses": {
+                        "200": {
+                            "description": "Successful Response",
+                            "content": {"application/json": {"schema": {}}},
+                        }
+                    },
+                }
+            }
+        },
+        "servers": [{"url": "/api/v1"}],
+    }

tests/test_tutorial/test_behind_a_proxy/test_tutorial001_01.py

@@ -0,0 +1,21 @@
+from fastapi.testclient import TestClient
+
+from docs_src.behind_a_proxy.tutorial001_01 import app
+
+client = TestClient(
+    app,
+    base_url="https://example.com",
+    follow_redirects=False,
+)
+
+
+def test_redirect() -> None:
+    response = client.get("/items")
+    assert response.status_code == 307
+    assert response.headers["location"] == "https://example.com/items/"
+
+
+def test_no_redirect() -> None:
+    response = client.get("/items/")
+    assert response.status_code == 200
+    assert response.json() == ["plumbus", "portal gun"]

tests/test_tutorial/test_behind_a_proxy/test_tutorial002.py

@@ -0,0 +1,35 @@
+from fastapi.testclient import TestClient
+
+from docs_src.behind_a_proxy.tutorial002 import app
+
+client = TestClient(app)
+
+
+def test_main():
+    response = client.get("/app")
+    assert response.status_code == 200
+    assert response.json() == {"message": "Hello World", "root_path": "/api/v1"}
+
+
+def test_openapi():
+    response = client.get("/openapi.json")
+    assert response.status_code == 200
+    assert response.json() == {
+        "openapi": "3.1.0",
+        "info": {"title": "FastAPI", "version": "0.1.0"},
+        "paths": {
+            "/app": {
+                "get": {
+                    "summary": "Read Main",
+                    "operationId": "read_main_app_get",
+                    "responses": {
+                        "200": {
+                            "description": "Successful Response",
+                            "content": {"application/json": {"schema": {}}},
+                        }
+                    },
+                }
+            }
+        },
+        "servers": [{"url": "/api/v1"}],
+    }

tests/test_tutorial/test_behind_a_proxy/test_tutorial003.py

@@ -0,0 +1,54 @@
+from dirty_equals import IsOneOf
+from fastapi.testclient import TestClient
+
+from docs_src.behind_a_proxy.tutorial003 import app
+
+client = TestClient(app)
+
+
+def test_main():
+    response = client.get("/app")
+    assert response.status_code == 200
+    assert response.json() == {"message": "Hello World", "root_path": "/api/v1"}
+
+
+def test_openapi_schema():
+    response = client.get("/openapi.json")
+    assert response.status_code == 200
+    assert response.json() == {
+        "openapi": "3.1.0",
+        "info": {"title": "FastAPI", "version": "0.1.0"},
+        "servers": [
+            {"url": "/api/v1"},
+            {
+                "url": IsOneOf(
+                    "https://stag.example.com/",
+                    # TODO: remove when deprecating Pydantic v1
+                    "https://stag.example.com",
+                ),
+                "description": "Staging environment",
+            },
+            {
+                "url": IsOneOf(
+                    "https://prod.example.com/",
+                    # TODO: remove when deprecating Pydantic v1
+                    "https://prod.example.com",
+                ),
+                "description": "Production environment",
+            },
+        ],
+        "paths": {
+            "/app": {
+                "get": {
+                    "summary": "Read Main",
+                    "operationId": "read_main_app_get",
+                    "responses": {
+                        "200": {
+                            "description": "Successful Response",
+                            "content": {"application/json": {"schema": {}}},
+                        }
+                    },
+                }
+            }
+        },
+    }

tests/test_tutorial/test_behind_a_proxy/test_tutorial004.py

@@ -0,0 +1,53 @@
+from dirty_equals import IsOneOf
+from fastapi.testclient import TestClient
+
+from docs_src.behind_a_proxy.tutorial004 import app
+
+client = TestClient(app)
+
+
+def test_main():
+    response = client.get("/app")
+    assert response.status_code == 200
+    assert response.json() == {"message": "Hello World", "root_path": "/api/v1"}
+
+
+def test_openapi_schema():
+    response = client.get("/openapi.json")
+    assert response.status_code == 200
+    assert response.json() == {
+        "openapi": "3.1.0",
+        "info": {"title": "FastAPI", "version": "0.1.0"},
+        "servers": [
+            {
+                "url": IsOneOf(
+                    "https://stag.example.com/",
+                    # TODO: remove when deprecating Pydantic v1
+                    "https://stag.example.com",
+                ),
+                "description": "Staging environment",
+            },
+            {
+                "url": IsOneOf(
+                    "https://prod.example.com/",
+                    # TODO: remove when deprecating Pydantic v1
+                    "https://prod.example.com",
+                ),
+                "description": "Production environment",
+            },
+        ],
+        "paths": {
+            "/app": {
+                "get": {
+                    "summary": "Read Main",
+                    "operationId": "read_main_app_get",
+                    "responses": {
+                        "200": {
+                            "description": "Successful Response",
+                            "content": {"application/json": {"schema": {}}},
+                        }
+                    },
+                }
+            }
+        },
+    }