def test_custom_route_definitions(app, client, specs_root, snapshot):
spec_router = SpecRouter(specs_root / "ihan")
@spec_router.post("/Weather/Current/Metric")
def weather_metric(request, vendor: str, auth_header: str = Header(...)):
return {"customRoute": ""}
app.include_router(spec_router.to_fastapi_router())
resp = client.post("/Weather/Current/Metric", json={"lat": "30.5", "lon": 1.56})
assert resp.status_code == 422
snapshot.assert_match(resp.json(), "Custom route definition")
def test_default_post_handler(app, client, specs_root, snapshot):
spec_router = SpecRouter(specs_root / "ihan")
@spec_router.post()
def company_info(request):
return company_basic_info_resp
app.include_router(spec_router.to_fastapi_router())
resp = client.post("/Company/BasicInfo", json={"companyId": "test"})
assert resp.status_code == 200
assert resp.json() == company_basic_info_resp
def test_company_custom_post_route(app, client, specs_root, snapshot):
spec_router = SpecRouter(specs_root / "ihan")
@spec_router.post("/Company/BasicInfo")
def weather_metric(request):
return company_basic_info_resp
app.include_router(spec_router.to_fastapi_router())
resp = client.post("/Company/BasicInfo", json={"companyId": "test"})
assert resp.status_code == 200, resp.json()
assert resp.json() == company_basic_info_resp
def test_weather_route_payload_errors(app, specs_root, client, snapshot):
spec_router = SpecRouter(specs_root / "ihan")
@spec_router.post("/Weather/Current/Metric")
def weather_metric(request):
return {}
app.include_router(spec_router.to_fastapi_router())
resp = client.post("/Weather/Current/Metric", json={})
assert resp.status_code == 422
snapshot.assert_match(resp.json(), "Missing payload")
resp = client.post("/Weather/Current/Metric", json={"lat": "1,1.2", "lon": "99999"})
assert resp.status_code == 422
snapshot.assert_match(resp.json(), "Incorrect payload type")
def test_custom_route_name_for_default_post(app, client, specs_root):
spec_router = SpecRouter(specs_root / "ihan")
def name_factory(path="", **kwargs):
return path[1:]
@spec_router.post(name_factory=name_factory)
def weather_metric(request):
return {}
router = spec_router.to_fastapi_router()
route = [r for r in router.routes if r.path == "/Company/BasicInfo"][0]
assert route.name == "Company/BasicInfo"
# test that generating OpenAPI still works
app.include_router(router)
assert app.openapi()
def test_routes_meta_info_custom_name(app, client, specs_root):
spec_router = SpecRouter(specs_root / "ihan")
def name_factory(path="", **kwargs):
return path[1:]
@spec_router.post("/Company/BasicInfo", name_factory=name_factory)
def weather_metric(request):
return {}
router = spec_router.to_fastapi_router()
route = [r for r in router.routes if r.path == "/Company/BasicInfo"][0]
assert route.name == "Company/BasicInfo"
assert route.summary == "Company/BasicInfo"
# description by default is coming from spec
assert route.description == "Information about the company"
# test that generating OpenAPI still works
app.include_router(router)
assert app.openapi()
def test_routes_meta_info(app, client, specs_root):
spec_router = SpecRouter(specs_root / "ihan")
@spec_router.post(
"/Weather/Current/Metric",
name="The Route",
tags=["Routes"],
description="Route description",
response_description="Response description",
)
def weather_metric(request):
return {}
router = spec_router.to_fastapi_router()
route = [r for r in router.routes if r.path == "/Weather/Current/Metric"][0]
assert route.name == "The Route"
assert route.tags == ["Routes"]
assert route.description == "Route description"
assert route.response_description == "Response description"
# test that generating OpenAPI still works
app.include_router(router)
assert app.openapi()
def test_response_model_is_parsed(app, client, specs_root):
spec_router = SpecRouter(specs_root / "ihan")
@spec_router.post("/Weather/Current/Metric")
def weather_metric(request):
return {}
spec_router.to_fastapi_router()
assert spec_router.get_response_model("/Weather/Current/Metric", "get") is None
resp_model = spec_router.get_response_model("/Weather/Current/Metric", "post")
assert resp_model is not None
with pytest.raises(pydantic.ValidationError):
resp_model()
assert resp_model(
humidity=1, pressure=1, rain=False, temp=30, windSpeed=1, windDirection=1.0
)
def ihan_client(specs_root):
app = FastAPI()
spec_router = SpecRouter(specs_root / "ihan")
app.include_router(spec_router.to_fastapi_router())
return TestClient(app)