From e655e876d81d9f928e5fa92c7706dce9473ea380 Mon Sep 17 00:00:00 2001 From: "Leonov Artur (Depish)" Date: Mon, 16 Dec 2024 12:21:51 +0300 Subject: [PATCH] =?UTF-8?q?=D0=9E=D0=B1=D0=BD=D0=BE=D0=B2=D0=B8=D0=BB=20re?= =?UTF-8?q?adme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b9c56e8..d3b3c24 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,18 @@ - Поддержка пространств имен, приложений и версий - Безопасность при одновременных запросах - Разворачивание через Docker +- Требование авторизации по токену (Bearer токен) + +## Авторизация + +Все запросы к эндпоинтам должны быть авторизованы с помощью заголовка `Authorization` и Bearer токена. +Пример заголовка авторизации: + +```http +Authorization: Bearer mysecrettoken +``` + +Где **mysecrettoken** — это ваш действительный токен авторизации. ## API Документация @@ -25,6 +37,7 @@ - `namespace` (строка) - `application` (строка) - `version` (строка) +- **Авторизация**: Необходим заголовок Authorization с Bearer токеном. - **Ответ**: ```json @@ -44,6 +57,7 @@ - `namespace` (строка) - `application` (строка) - `version` (строка) +- **Авторизация**: Необходим заголовок Authorization с Bearer токеном. - **Ответ**: ```json @@ -63,6 +77,7 @@ - `namespace` (строка) - `application` (строка) - `version` (строка) +- **Авторизация**: Необходим заголовок Authorization с Bearer токеном. - **Ответ**: ```json @@ -79,18 +94,27 @@ ### Инкрементировать счетчик ```bash -curl -X POST "http://localhost:8000/my_namespace/my_app/1.0" -H "Content-Type: application/json" +curl -X POST \ + "http://localhost:8000/my_namespace/my_app/1.0" \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer mysecrettoken" ``` Получить значение счетчика ```bash -curl -X GET "http://localhost:8000/my_namespace/my_app/1.0" -H "Content-Type: application/json" +curl -X GET \ + "http://localhost:8000/my_namespace/my_app/1.0" \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer mysecrettoken" ``` Сбросить счетчик ```bash -curl -X DELETE "http://localhost:8000/my_namespace/my_app/1.0" -H "Content-Type: application/json" +curl -X DELETE \ + "http://localhost:8000/my_namespace/my_app/1.0" \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer mysecrettoken" ```