test-php-rest-api-user/README.md

50 lines
1.6 KiB
Markdown
Raw Normal View History

2024-08-09 23:07:12 +08:00
# test-php-rest-api-user
2024-08-10 01:51:29 +08:00
**Тестовое задание REST API на PHP**
### [Postman](https://www.postman.com/material-observer-62618807/workspace/public-data/collection/37579698-ff75f993-cc82-4704-aea4-612718b8a06b?action=share&creator=37579698)
## Документация API
### POST `/api/v1/createUser`
2024-08-10 01:54:28 +08:00
Создание пользователя
2024-08-10 01:51:29 +08:00
Параметр | Описание
--- | ---
login | Обязательное поле (1-32 символа)
password | Обязательное поле (от 8 символов)
2024-08-10 01:54:28 +08:00
2024-08-10 01:51:29 +08:00
### POST `/api/v1/authUser`
2024-08-10 01:54:28 +08:00
Авторизация и получение токена
2024-08-10 01:51:29 +08:00
Параметр | Описание
--- | ---
login | Обязательное поле (1-32 символа)
password | Обязательное поле (от 8 символов)
2024-08-10 01:54:28 +08:00
2024-08-10 01:51:29 +08:00
### GET `/api/v1/getUser`
2024-08-10 01:54:28 +08:00
Получение информации о пользователе
2024-08-10 01:51:29 +08:00
Параметр | Описание
--- | ---
login | Обязательное поле (1-32 символа)
2024-08-10 01:54:28 +08:00
2024-08-10 01:51:29 +08:00
### PATCH `/api/v1/updateUserInfo`
2024-08-10 01:54:28 +08:00
Обновление поля info у пользователя
2024-08-10 01:51:29 +08:00
Параметр | Описание
--- | ---
token | Обязательное поле (токен, который выдали при авторизации)
newInfo | Обязательное поле (без ограничений)
2024-08-10 01:54:28 +08:00
2024-08-10 01:51:29 +08:00
### DELETE `/api/v1/deleteUser`
2024-08-10 01:54:28 +08:00
Удаление пользователя
2024-08-10 01:51:29 +08:00
Параметр | Описание
--- | ---
token | Обязательное поле (токен, который выдали при авторизации)