Добавил описание endpoint'ов

This commit is contained in:
2026-09-30 13:56:56 +07:00
parent c8b39be5b4
commit 371cdfb6c5
+76 -1
View File
@@ -8,7 +8,7 @@ STA - сеть к которой подключается комутатор
Значиния по умолчанию:
AP сеть:
AP SSID: Mirror
AP PASSWORD: *$sd!Df^67_sS52d
AP PASSWORD: *\$sd!Df^67_sS52d
Админка:
Login: admin
@@ -20,3 +20,78 @@ Password: admin
![Смена пвроля администратора](screenshots/settings_admin.png)
## API управления (Управляющие Endpoint'ы)
Все эндпоинты управления требуют **HTTP Basic Auth** авторизации. В случае неуспешной авторизации сервер возвращает статус `401 Unauthorized`.
При отправке настроек, некорректный JSON или отсутствие обязательных полей вызовет ответ со статусом `400 Bad Request`.
---
### Обновление настроек точки доступа (AP)
* **URL:** `/settings/ap_update`
* **Метод:** `POST` (передается в теле запроса `plain`)
* **Тело запроса (JSON):**
```json
{
"ssid": "Имя_сети_AP",
"pass": "Пароль_сети_AP"
}
```
* **Ответ:** `200 OK` (после успешного сохранения устройство перезагружается).
### Обновление настроек подключения к роутеру (STA)
* **URL:** `/settings/sta_update`
* **Метод:** `POST`
* **Тело запроса (JSON):**
```json
{
"ssid": "Имя_вашего_WIFI",
"pass": "Пароль_от_WIFI"
}
```
* **Ответ:** `200 OK` (после успешного сохранения устройство перезагружается).
### Изменение пароля администратора
* **URL:** `/settings/admin_update`
* **Метод:** `POST`
* **Тело запроса (JSON):**
```json
{
"new_pass": "Новый_пароль_админа"
}
```
* **Ответ:** `200 OK`.
### Получение статуса внешнего подключения (Conn Out)
* **URL:** `/settings/is_conn_out`
* **Метод:** `GET`
* **Ответ:** `200 OK` c JSON-контентом `application/json`:
```json
{
"is_conn_out": true
}
```
### Установка статуса внешнего подключения (Conn Out)
* **URL:** `/settings/set_conn_out`
* **Метод:** `POST`
* **Тело запроса (JSON):**
```json
{
"is_conn_out": true
}
```
* **Ответ:** `200 OK` (после успешного изменения устройство перезагружается).
### Получение списка подключенных клиентов
Возвращает сетевые параметры устройств, подключенных в данный момент к точке доступа коммутатора (SoftAP).
* **URL:** `/user_list`
* **Метод:** `GET`
* **Ответ:** `200 OK` с JSON-контентом `application/json`:
```json
{
"user_ip": ["192.168.4.2", "192.168.4.3"],
"user_mac": ["a1:b2:c3:d4:e5:f6", "7a:8b:9c:0d:1e:2f"]
}
```