Add README.md

2025-03-20 22:15:50 +03:00 · 2025-03-20 22:15:50 +03:00 · 1ff63dfdc0
commit 1ff63dfdc0
parent 2cc798376c
1 changed files with 14 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,14 @@
+# Библиотека openapi контрактов
+
+Библиотека содержит openapi описание методов используемых для интеграции аппаратной части и информационной системы
+
+## Сборка библиотеки
+
+При сборке будут сгенерированы классы контроллеров и DTO скомпилированы и упакованы в jar файл
+
+`gradle jar`
+
+## Описанные методы
+
+- GET /qr - метод получения qr-кодов
+- POST /qr-used/{qrId} - метод отметки использования qr-кода клиентом(для сбора метрик)