BitHeaven
/
test-php-rest-api-user
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add description to API endpionts

This commit is contained in:
root 2024-08-10 01:54:28 +08:00
parent 19b02d7089
commit 44c7988429
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -7,29 +7,43 @@
## Документация API ## Документация API
### POST `/api/v1/createUser` ### POST `/api/v1/createUser`
Создание пользователя
Параметр | Описание Параметр | Описание
--- | --- --- | ---
login | Обязательное поле (1-32 символа) login | Обязательное поле (1-32 символа)
password | Обязательное поле (от 8 символов) password | Обязательное поле (от 8 символов)
### POST `/api/v1/authUser` ### POST `/api/v1/authUser`
Авторизация и получение токена
Параметр | Описание Параметр | Описание
--- | --- --- | ---
login | Обязательное поле (1-32 символа) login | Обязательное поле (1-32 символа)
password | Обязательное поле (от 8 символов) password | Обязательное поле (от 8 символов)
### GET `/api/v1/getUser` ### GET `/api/v1/getUser`
Получение информации о пользователе
Параметр | Описание Параметр | Описание
--- | --- --- | ---
login | Обязательное поле (1-32 символа) login | Обязательное поле (1-32 символа)
### PATCH `/api/v1/updateUserInfo` ### PATCH `/api/v1/updateUserInfo`
Обновление поля info у пользователя
Параметр | Описание Параметр | Описание
--- | --- --- | ---
token | Обязательное поле (токен, который выдали при авторизации) token | Обязательное поле (токен, который выдали при авторизации)
newInfo | Обязательное поле (без ограничений) newInfo | Обязательное поле (без ограничений)
### DELETE `/api/v1/deleteUser` ### DELETE `/api/v1/deleteUser`
Удаление пользователя
Параметр | Описание Параметр | Описание
--- | --- --- | ---
token | Обязательное поле (токен, который выдали при авторизации) token | Обязательное поле (токен, который выдали при авторизации)