library/docs-fastapi
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Sync fastapi docs from b5ca1324 on 2025-12-07
Issue Manager / issue-manager (push) Has been cancelled
Details
Build Docs / changes (push) Has been cancelled
Details
Build Docs / langs (push) Has been cancelled
Details
Build Docs / build-docs (push) Has been cancelled
Details
Build Docs / docs-all-green (push) Has been cancelled
Details
Conflict detector / main (push) Has been cancelled
Details
Test Redistribute / test-redistribute (fastapi) (push) Has been cancelled
Details
Test Redistribute / test-redistribute (fastapi-slim) (push) Has been cancelled
Details
Test Redistribute / test-redistribute-alls-green (push) Has been cancelled
Details
Test / lint (push) Has been cancelled
Details
Test / test (pydantic-v1, 3.10) (push) Has been cancelled
Details
Test / test (pydantic-v1, 3.11) (push) Has been cancelled
Details
Test / test (pydantic-v1, 3.13) (push) Has been cancelled
Details
Test / test (pydantic-v1, 3.8) (push) Has been cancelled
Details
Test / test (pydantic-v1, 3.9) (push) Has been cancelled
Details
Test / test (pydantic-v2, 3.10) (push) Has been cancelled
Details
Test / test (pydantic-v2, 3.11) (push) Has been cancelled
Details
Test / test (pydantic-v2, 3.12) (push) Has been cancelled
Details
Test / test (pydantic-v2, 3.13) (push) Has been cancelled
Details
Test / test (pydantic-v2, 3.14) (push) Has been cancelled
Details
Test / test (pydantic-v2, 3.8) (push) Has been cancelled
Details
Test / test (pydantic-v2, 3.9) (push) Has been cancelled
Details
Test / coverage-combine (push) Has been cancelled
Details
Test / check (push) Has been cancelled
Details
Label Approved / label-approved (push) Has been cancelled
Details
FastAPI People Contributors / job (push) Has been cancelled
Details
FastAPI People Sponsors / job (push) Has been cancelled
Details
Update Topic Repos / topic-repos (push) Has been cancelled
Details
FastAPI People / job (push) Has been cancelled
Details
Test / test (pydantic-v1, 3.12) (push) Has been cancelled
Details

Browse Source
This commit is contained in:
The Scheduler
2025-12-07 21:35:20 +00:00
commit a42b1ff04e
2600 changed files with 301870 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/test_tutorial/test_path_params/__init__.py
View File
tests/test_tutorial/test_path_params/test_tutorial004.py
+91
View File
@@ -0,0 +1,91 @@
from fastapi.testclient import TestClient
from docs_src.path_params.tutorial004 import app
client = TestClient(app)
def test_file_path():
response = client.get("/files/home/johndoe/myfile.txt")
print(response.content)
assert response.status_code == 200, response.text
assert response.json() == {"file_path": "home/johndoe/myfile.txt"}
def test_root_file_path():
response = client.get("/files//home/johndoe/myfile.txt")
print(response.content)
assert response.status_code == 200, response.text
assert response.json() == {"file_path": "/home/johndoe/myfile.txt"}
def test_openapi_schema():
response = client.get("/openapi.json")
assert response.status_code == 200, response.text
assert response.json() == {
"openapi": "3.1.0",
"info": {"title": "FastAPI", "version": "0.1.0"},
"paths": {
"/files/{file_path}": {
"get": {
"responses": {
"200": {
"description": "Successful Response",
"content": {"application/json": {"schema": {}}},
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
},
},
"summary": "Read File",
"operationId": "read_file_files__file_path__get",
"parameters": [
{
"required": True,
"schema": {"title": "File Path", "type": "string"},
"name": "file_path",
"in": "path",
}
],
}
}
},
"components": {
"schemas": {
"ValidationError": {
"title": "ValidationError",
"required": ["loc", "msg", "type"],
"type": "object",
"properties": {
"loc": {
"title": "Location",
"type": "array",
"items": {
"anyOf": [{"type": "string"}, {"type": "integer"}]
},
},
"msg": {"title": "Message", "type": "string"},
"type": {"title": "Error Type", "type": "string"},
},
},
"HTTPValidationError": {
"title": "HTTPValidationError",
"type": "object",
"properties": {
"detail": {
"title": "Detail",
"type": "array",
"items": {"$ref": "#/components/schemas/ValidationError"},
}
},
},
}
},
}
tests/test_tutorial/test_path_params/test_tutorial005.py
+143
View File
@@ -0,0 +1,143 @@
from dirty_equals import IsDict
from fastapi.testclient import TestClient
from docs_src.path_params.tutorial005 import app
client = TestClient(app)
def test_get_enums_alexnet():
response = client.get("/models/alexnet")
assert response.status_code == 200
assert response.json() == {"model_name": "alexnet", "message": "Deep Learning FTW!"}
def test_get_enums_lenet():
response = client.get("/models/lenet")
assert response.status_code == 200
assert response.json() == {"model_name": "lenet", "message": "LeCNN all the images"}
def test_get_enums_resnet():
response = client.get("/models/resnet")
assert response.status_code == 200
assert response.json() == {"model_name": "resnet", "message": "Have some residuals"}
def test_get_enums_invalid():
response = client.get("/models/foo")
assert response.status_code == 422
assert response.json() == IsDict(
{
"detail": [
{
"type": "enum",
"loc": ["path", "model_name"],
"msg": "Input should be 'alexnet', 'resnet' or 'lenet'",
"input": "foo",
"ctx": {"expected": "'alexnet', 'resnet' or 'lenet'"},
}
]
}
) | IsDict(
# TODO: remove when deprecating Pydantic v1
{
"detail": [
{
"ctx": {"enum_values": ["alexnet", "resnet", "lenet"]},
"loc": ["path", "model_name"],
"msg": "value is not a valid enumeration member; permitted: 'alexnet', 'resnet', 'lenet'",
"type": "type_error.enum",
}
]
}
)
def test_openapi_schema():
response = client.get("/openapi.json")
assert response.status_code == 200, response.text
data = response.json()
assert data == {
"openapi": "3.1.0",
"info": {"title": "FastAPI", "version": "0.1.0"},
"paths": {
"/models/{model_name}": {
"get": {
"summary": "Get Model",
"operationId": "get_model_models__model_name__get",
"parameters": [
{
"required": True,
"schema": {"$ref": "#/components/schemas/ModelName"},
"name": "model_name",
"in": "path",
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {"application/json": {"schema": {}}},
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
},
},
}
}
},
"components": {
"schemas": {
"HTTPValidationError": {
"title": "HTTPValidationError",
"type": "object",
"properties": {
"detail": {
"title": "Detail",
"type": "array",
"items": {"$ref": "#/components/schemas/ValidationError"},
}
},
},
"ModelName": IsDict(
{
"title": "ModelName",
"enum": ["alexnet", "resnet", "lenet"],
"type": "string",
}
)
| IsDict(
{
# TODO: remove when deprecating Pydantic v1
"title": "ModelName",
"enum": ["alexnet", "resnet", "lenet"],
"type": "string",
"description": "An enumeration.",
}
),
"ValidationError": {
"title": "ValidationError",
"required": ["loc", "msg", "type"],
"type": "object",
"properties": {
"loc": {
"title": "Location",
"type": "array",
"items": {
"anyOf": [{"type": "string"}, {"type": "integer"}]
},
},
"msg": {"title": "Message", "type": "string"},
"type": {"title": "Error Type", "type": "string"},
},
},
}
},
}