Skip to content

openfoodfacts_proxy.routes.v2.read

[docs] module openfoodfacts_proxy.routes.v2.read 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
from fastapi import APIRouter, Query, Request
from fastapi.responses import Response

from openfoodfacts_proxy.core.application_container import ApplicationContainer

router = APIRouter()


@router.get("/api/v2/product/{barcode}.json", response_model=None)
async def get_product_json(
    request: Request,
    barcode: str,
    fields: str | None = Query(None),
    blame: int | None = Query(None),
) -> Response:
    """Serve the cached v2 product locally and fall back to upstream proxying."""
    del blame
    container = ApplicationContainer.from_app(request.app)
    return await container.v2_product_handler.handle(request, barcode=barcode, fields=fields)


@router.get("/api/v2/product/{barcode}", response_model=None)
async def get_product(
    request: Request,
    barcode: str,
    fields: str | None = Query(None),
    blame: int | None = Query(None),
) -> Response:
    """Alias for the documented OFF v2 product endpoint without the .json suffix."""
    del blame
    container = ApplicationContainer.from_app(request.app)
    return await container.v2_product_handler.handle(request, barcode=barcode, fields=fields)


@router.get("/api/v2/product/{barcode}/{product_name}", response_model=None)
async def get_product_with_name(
    request: Request,
    barcode: str,
    product_name: str,
    fields: str | None = Query(None),
    blame: int | None = Query(None),
) -> Response:
    """Documented OFF v2 product endpoint with a slugged product name."""
    del blame, product_name
    container = ApplicationContainer.from_app(request.app)
    return await container.v2_product_handler.handle(request, barcode=barcode, fields=fields)


@router.get("/api/v2/search", response_model=None)
async def search(
    request: Request,
    code: str | None = Query(None),
    product_name: str | None = Query(None, alias="search_terms"),
    brands: str | None = Query(None),
    categories_tags: str | None = Query(None, alias="categories_tags_en"),
    nutrition_grades: str | None = Query(None, alias="nutrition_grades_tags"),
    sort_by: str | None = Query(None),
    page: int = Query(1),
    page_size: int = Query(24),
    fields: str | None = Query(None),
) -> Response:
    """Serve supported v2 search requests locally and proxy the rest upstream."""
    container = ApplicationContainer.from_app(request.app)
    return await container.v2_search_handler.handle(
        request,
        code=code,
        product_name=product_name,
        brands=brands,
        categories_tags=categories_tags,
        nutrition_grades=nutrition_grades,
        page=page,
        page_size=page_size,
        sort_by=sort_by,
        fields=fields,
    )