From 0c1d76a412ef8c6f65ebc523b9eb5a2a6f663035 Mon Sep 17 00:00:00 2001 From: Red Date: Sat, 27 Sep 2025 02:19:34 +0500 Subject: [PATCH] =?UTF-8?q?=D0=98=D0=B7=D0=BC=D0=B5=D0=BD=D0=B5=D0=BD=20RE?= =?UTF-8?q?ADME?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 42 +----------------------------------------- 1 file changed, 1 insertion(+), 41 deletions(-) diff --git a/README.md b/README.md index 21f01c7..162847b 100644 --- a/README.md +++ b/README.md @@ -11,44 +11,4 @@ - Оформлено в виде удобного api, с понятными конечными маршрутами. - Хранилище в виде базы данных(sqlite) с собственной оберткой. - AES-шифрование из коробки. Обязательно нужно обновить ключ в /keys перед продакшн-деплоем. - - Дружелюбный язык и стэк - node js, express. Это вам не сложный java и Spring Boot. - - - -# Краткое руководство -### Суть -Предполагается, что: - -1. Сервис будет запускаться локально (извне обращения игнорироваться). -2. Использоваться для благих целей. - -### Как пользоваться -Пользоваться им очень просто, как два пальца об асфальт. - -#### Для создания ключа: -Нужно обратиться к /reg-key с такой структурой: -``` -POST /reg-key -body: { - "name": "Example", - "update": 24 -} -``` - -где: -- update - интервал обновления -- name - название ключа - -#### Для получения ключа: -Тут тоже все просто, отличие лишь в способе передачи информации: -``` -GET /get-key -query-параметры: - - name - - kid (опционально) - -примеры: - - http://localhost/get-key?name=Example - - http://localhost/get-key?name=Example&kid=4adc0149-49e7-45e7-b0af-5e0c4da5fe3f -``` -Все, это все что вам нужно знать, чтобы использовать этот сервис. + - Дружелюбный язык и стэк - node js, express. Это вам не сложный java и Spring Boot. \ No newline at end of file