Package ru.hackaton.controllers
Class CheckRemainingsController
java.lang.Object
ru.hackaton.controllers.CheckRemainingsController
@RestController
@RequestMapping("/check-remainings")
public class CheckRemainingsController
extends Object
REST контроллер для проверки остатков продукта.
Этот контроллер предоставляет эндпоинт для проверки остатков определенного продукта,
который возвращает сообщение и изображение (если доступно).
Аннотация
RestController
указывает, что этот класс является контроллером Spring.
Аннотация RequestMapping
определяет базовый URL для всех эндпоинтов в этом контроллере.
Аннотация Tag
добавляет метаданные OpenAPI для этого контроллера.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntity
<ru.hackaton.controllers.CheckRemainingsController.RemainingsResponse> checkRemainings
(String product) Эндпоинт для проверки остатков продукта.
-
Constructor Details
-
CheckRemainingsController
public CheckRemainingsController()
-
-
Method Details
-
checkRemainings
@GetMapping public org.springframework.http.ResponseEntity<ru.hackaton.controllers.CheckRemainingsController.RemainingsResponse> checkRemainings(@RequestParam("product") String product) Эндпоинт для проверки остатков продукта. Этот метод вызывает Python-скрипт для проверки остатков продукта и возвращает результат в виде сообщения и изображения (если доступно).- Parameters:
product
- Название продукта, для которого необходимо проверить остатки.- Returns:
- Объект
ResponseEntity
с результатом проверки, содержащий сообщение и изображение (если доступно).
-