Обновил readme
This commit is contained in:
30
README.md
30
README.md
@@ -10,6 +10,18 @@
|
|||||||
- Поддержка пространств имен, приложений и версий
|
- Поддержка пространств имен, приложений и версий
|
||||||
- Безопасность при одновременных запросах
|
- Безопасность при одновременных запросах
|
||||||
- Разворачивание через Docker
|
- Разворачивание через Docker
|
||||||
|
- Требование авторизации по токену (Bearer токен)
|
||||||
|
|
||||||
|
## Авторизация
|
||||||
|
|
||||||
|
Все запросы к эндпоинтам должны быть авторизованы с помощью заголовка `Authorization` и Bearer токена.
|
||||||
|
Пример заголовка авторизации:
|
||||||
|
|
||||||
|
```http
|
||||||
|
Authorization: Bearer mysecrettoken
|
||||||
|
```
|
||||||
|
|
||||||
|
Где **mysecrettoken** — это ваш действительный токен авторизации.
|
||||||
|
|
||||||
## API Документация
|
## API Документация
|
||||||
|
|
||||||
@@ -25,6 +37,7 @@
|
|||||||
- `namespace` (строка)
|
- `namespace` (строка)
|
||||||
- `application` (строка)
|
- `application` (строка)
|
||||||
- `version` (строка)
|
- `version` (строка)
|
||||||
|
- **Авторизация**: Необходим заголовок Authorization с Bearer токеном.
|
||||||
- **Ответ**:
|
- **Ответ**:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@@ -44,6 +57,7 @@
|
|||||||
- `namespace` (строка)
|
- `namespace` (строка)
|
||||||
- `application` (строка)
|
- `application` (строка)
|
||||||
- `version` (строка)
|
- `version` (строка)
|
||||||
|
- **Авторизация**: Необходим заголовок Authorization с Bearer токеном.
|
||||||
- **Ответ**:
|
- **Ответ**:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@@ -63,6 +77,7 @@
|
|||||||
- `namespace` (строка)
|
- `namespace` (строка)
|
||||||
- `application` (строка)
|
- `application` (строка)
|
||||||
- `version` (строка)
|
- `version` (строка)
|
||||||
|
- **Авторизация**: Необходим заголовок Authorization с Bearer токеном.
|
||||||
- **Ответ**:
|
- **Ответ**:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@@ -79,18 +94,27 @@
|
|||||||
### Инкрементировать счетчик
|
### Инкрементировать счетчик
|
||||||
|
|
||||||
```bash
|
```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
|
```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
|
```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"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user