mirror of
https://github.com/fastapi/fastapi.git
synced 2026-01-31 01:11:17 -05:00
1f01ce9615
* Updated .py files with Optional tag (up to body_nested_models) * Update optionals * docs_src/ all updates, few I was unsure of * Updated markdown files with Optional param * es: Add Optional typing to index.md * Last of markdown files updated with Optional param * Update highlight lines * it: Add Optional typings * README.md: Update with Optional typings * Update more highlight increments * Update highlights * schema-extra-example.md: Update highlights * updating highlighting on website to reflect .py changes * Update highlighting for query-params & response-directly * Address PR comments * Get rid of unnecessary comment * ⏪ Revert Optional in Chinese docs as it probably also requires changes in text * 🎨 Apply format * ⏪ Revert modified example * ♻️ Simplify example in docs * 📝 Update OpenAPI callback example to use Optional * ✨ Add Optional types to tests * 📝 Update docs about query params, default to using Optional * 🎨 Update code examples line highlighting * 📝 Update nested models docs to use "type parameters" instead of "subtypes" * 📝 Add notes about FastAPI usage of None including: = None and = Query(None) and clarify relationship with Optional[str] * 📝 Add note about response_model_by_alias * ♻️ Simplify query param list example * 🔥 Remove test for removed example * ✅ Update test for updated example Co-authored-by: Christopher Nguyen <chrisngyn99@gmail.com> Co-authored-by: yk396 <yk396@cornell.edu> Co-authored-by: Kai Chen <kaichen120@gmail.com>
139 lines
4.0 KiB
Python
139 lines
4.0 KiB
Python
from typing import Optional
|
|
|
|
from fastapi import APIRouter, FastAPI
|
|
from fastapi.testclient import TestClient
|
|
|
|
app = FastAPI()
|
|
|
|
|
|
user_router = APIRouter()
|
|
item_router = APIRouter()
|
|
|
|
|
|
@user_router.get("/")
|
|
def get_users():
|
|
return [{"user_id": "u1"}, {"user_id": "u2"}]
|
|
|
|
|
|
@user_router.get("/{user_id}")
|
|
def get_user(user_id: str):
|
|
return {"user_id": user_id}
|
|
|
|
|
|
@item_router.get("/")
|
|
def get_items(user_id: Optional[str] = None):
|
|
if user_id is None:
|
|
return [{"item_id": "i1", "user_id": "u1"}, {"item_id": "i2", "user_id": "u2"}]
|
|
else:
|
|
return [{"item_id": "i2", "user_id": user_id}]
|
|
|
|
|
|
@item_router.get("/{item_id}")
|
|
def get_item(item_id: str, user_id: Optional[str] = None):
|
|
if user_id is None:
|
|
return {"item_id": item_id}
|
|
else:
|
|
return {"item_id": item_id, "user_id": user_id}
|
|
|
|
|
|
app.include_router(user_router, prefix="/users")
|
|
app.include_router(item_router, prefix="/items")
|
|
|
|
app.include_router(item_router, prefix="/users/{user_id}/items")
|
|
|
|
|
|
client = TestClient(app)
|
|
|
|
|
|
def test_get_users():
|
|
"""Check that /users returns expected data"""
|
|
response = client.get("/users")
|
|
assert response.status_code == 200, response.text
|
|
assert response.json() == [{"user_id": "u1"}, {"user_id": "u2"}]
|
|
|
|
|
|
def test_get_user():
|
|
"""Check that /users/{user_id} returns expected data"""
|
|
response = client.get("/users/abc123")
|
|
assert response.status_code == 200, response.text
|
|
assert response.json() == {"user_id": "abc123"}
|
|
|
|
|
|
def test_get_items_1():
|
|
"""Check that /items returns expected data"""
|
|
response = client.get("/items")
|
|
assert response.status_code == 200, response.text
|
|
assert response.json() == [
|
|
{"item_id": "i1", "user_id": "u1"},
|
|
{"item_id": "i2", "user_id": "u2"},
|
|
]
|
|
|
|
|
|
def test_get_items_2():
|
|
"""Check that /items returns expected data with user_id specified"""
|
|
response = client.get("/items?user_id=abc123")
|
|
assert response.status_code == 200, response.text
|
|
assert response.json() == [{"item_id": "i2", "user_id": "abc123"}]
|
|
|
|
|
|
def test_get_item_1():
|
|
"""Check that /items/{item_id} returns expected data"""
|
|
response = client.get("/items/item01")
|
|
assert response.status_code == 200, response.text
|
|
assert response.json() == {"item_id": "item01"}
|
|
|
|
|
|
def test_get_item_2():
|
|
"""Check that /items/{item_id} returns expected data with user_id specified"""
|
|
response = client.get("/items/item01?user_id=abc123")
|
|
assert response.status_code == 200, response.text
|
|
assert response.json() == {"item_id": "item01", "user_id": "abc123"}
|
|
|
|
|
|
def test_get_users_items():
|
|
"""Check that /users/{user_id}/items returns expected data"""
|
|
response = client.get("/users/abc123/items")
|
|
assert response.status_code == 200, response.text
|
|
assert response.json() == [{"item_id": "i2", "user_id": "abc123"}]
|
|
|
|
|
|
def test_get_users_item():
|
|
"""Check that /users/{user_id}/items returns expected data"""
|
|
response = client.get("/users/abc123/items/item01")
|
|
assert response.status_code == 200, response.text
|
|
assert response.json() == {"item_id": "item01", "user_id": "abc123"}
|
|
|
|
|
|
def test_schema_1():
|
|
"""Check that the user_id is a required path parameter under /users"""
|
|
response = client.get("/openapi.json")
|
|
assert response.status_code == 200, response.text
|
|
r = response.json()
|
|
|
|
d = {
|
|
"required": True,
|
|
"schema": {"title": "User Id", "type": "string"},
|
|
"name": "user_id",
|
|
"in": "path",
|
|
}
|
|
|
|
assert d in r["paths"]["/users/{user_id}"]["get"]["parameters"]
|
|
assert d in r["paths"]["/users/{user_id}/items/"]["get"]["parameters"]
|
|
|
|
|
|
def test_schema_2():
|
|
"""Check that the user_id is an optional query parameter under /items"""
|
|
response = client.get("/openapi.json")
|
|
assert response.status_code == 200, response.text
|
|
r = response.json()
|
|
|
|
d = {
|
|
"required": False,
|
|
"schema": {"title": "User Id", "type": "string"},
|
|
"name": "user_id",
|
|
"in": "query",
|
|
}
|
|
|
|
assert d in r["paths"]["/items/{item_id}"]["get"]["parameters"]
|
|
assert d in r["paths"]["/items/"]["get"]["parameters"]
|