Обновил readme

This commit is contained in:
2024-12-16 12:21:51 +03:00
parent bb60b5509c
commit e655e876d8

View File

@@ -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"
```