api.py

import base64
import pathlib
from typing import Literal
from fastapi import FastAPI, Path, Query
from pydantic import BaseModel, Field
from datetime import date

from fastapi.openapi.utils import get_openapi


class Item(BaseModel):
    id: str | None = Field(description="")
    name: str = Field(
        description='Optional unique identifier for the article, such as a GUID. Must not contain any "." or "/" characters. Different articles with the same price on different days should still have different IDs. If not set, a unique ID will be generated internally.'
    )
    price: float = Field(
        description="The default price for the articles. Default prices are shown to guests before authentication. Yet, the final price is based on priceLookup if present."
    )
    priceLookup: str = Field(
        description="The price lookup code for the article. Whatever identifier is used in the cash register to identify the price group of articles, such as an article ID."
    )
    category: Literal[
        "MAIN", "SIDE", "BOTTLE", "DESSERT", "DRINK", "SALAD", "SOUP", "OTHER"
    ] = Field(description="Category of the item.")


class Menu(BaseModel):
    date: str = Field(description="ISO date for which the menu is valid.")
    items: list[Item] = Field(description="List of items on the menu.")

    class Config:
        schema_extra = {
            "example": {
                "date": "2022-10-07",
                "items": [
                    {
                        "id": "abc",
                        "name": "Burger",
                        "price": 3.0,
                        "priceLookup": "123",
                        "category": "MAIN",
                    },
                    {
                        "id": "def",
                        "name": "Salad",
                        "price": 1.5,
                        "priceLookup": "456",
                        "category": "SALAD",
                    },
                ],
            }
        }


class Menus(BaseModel):
    menus: list[Menu] = Field(description="List of menus on separate dates.")

    class Config:
        schema_extra = {
            "example": {
                "menus": [
                    {
                        "date": "2023-01-01",
                        "items": [
                            {
                                "name": "Burger",
                                "price": 3.0,
                                "priceLookup": "123",
                                "category": "MAIN",
                            },
                            {
                                "name": "Salad",
                                "price": 1.5,
                                "priceLookup": "456",
                                "category": "SALAD",
                            },
                        ],
                    },
                    {
                        "date": "2023-01-02",
                        "items": [
                            {
                                "name": "Pasta",
                                "price": 3.0,
                                "priceLookup": "123",
                                "category": "MAIN",
                            },
                            {
                                "name": "Salad",
                                "price": 1.5,
                                "priceLookup": "546",
                                "category": "SALAD",
                            },
                        ],
                    },
                ]
            }
        }


class Message(BaseModel):
    """Message for additional information."""

    message: str


app = FastAPI(
    title="VisioLab Menu Import API",
    description="API for importing menus into the VisioLab backend.",
)


@app.get(
    "/menus/{date}",
    summary="Get menu for date",
    responses={
        200: {"model": Menu, "description": "The menu."},
        404: {
            "model": Message,
            "description": "No menu available for the requested date.",
        },
    },
)
async def get_menu(
    date: str = Path(
        description="Date for which the menu is requested.",
        example="2023-01-01",
    )
):
    return {
        "date": "2023-01-01",
        "items": [
            {
                "name": "Burger",
                "price": 3.0,
                "priceLookup": "123",
                "category": "MAIN",
            },
            {
                "name": "Salad",
                "price": 1.5,
                "priceLookup": "456",
                "category": "SALAD",
            },
        ],
    }


@app.get(
    "/menus/today",
    summary="Get menu for today",
    responses={
        200: {"model": Menu, "description": "The menu."},
        404: {
            "model": Message,
            "description": "No menu available for today.",
        },
    },
)
async def get_todays_menu():
    return {
        "date": "2023-01-01",
        "items": [
            {
                "name": "Burger",
                "price": 3.0,
                "priceLookup": "123",
                "category": "MAIN",
            },
            {
                "name": "Salad",
                "price": 1.5,
                "priceLookup": "456",
                "category": "SALAD",
            },
        ],
    }


@app.get(
    "/menus/",
    summary="Get menus for date range",
    responses={
        200: {"model": Menus, "description": "The menus."},
        404: {
            "model": Message,
            "description": "No menus available for the requested date range.",
        },
    },
)
async def get_menus(
    start: str = Query(
        description="Start date for which the menus are requested.",
        example="2023-01-01",
    ),
    end: str = Query(
        description="End date for which the menus are requested (inclusive).",
        example="2023-01-02",
    ),
):
    """Get items available in cash register to synchronize prices."""
    return {
        "menus": [
            {
                "date": "2023-01-01",
                "items": [
                    {
                        "name": "Burger",
                        "price": 3.0,
                        "priceLookup": "123",
                        "category": "MAIN",
                    },
                    {
                        "name": "Salad",
                        "price": 1.5,
                        "priceLookup": "456",
                        "category": "SALAD",
                    },
                ],
            },
            {
                "date": "2023-01-02",
                "items": [
                    {
                        "name": "Pasta",
                        "price": 3.0,
                        "priceLookup": "123",
                        "category": "MAIN",
                    },
                    {
                        "name": "Salad",
                        "price": 1.5,
                        "priceLookup": "546",
                        "category": "SALAD",
                    },
                ],
            },
        ]
    }


def as_base64_url(path):
    return "data:image/png;base64, " + base64.b64encode(
        pathlib.Path(path).read_bytes()
    ).decode("utf-8")


def custom_openapi():
    if app.openapi_schema:
        return app.openapi_schema
    openapi_schema = get_openapi(
        title=app.title,
        version=app.version,
        description=app.description,
        routes=app.routes,
    )
    openapi_schema["info"]["x-logo"] = {"url": as_base64_url("./logo.png")}
    app.openapi_schema = openapi_schema
    return app.openapi_schema


app.openapi = custom_openapi