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

Add API documentation

This commit is contained in:
root 2024-08-10 01:51:29 +08:00
parent cbd55cec2d
commit 19b02d7089
1 changed files with 33 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,3 +1,35 @@
# test-php-rest-api-user # test-php-rest-api-user
Тестовое задание REST API на PHP **Тестовое задание 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`
Параметр | Описание
--- | ---
login | Обязательное поле (1-32 символа)
password | Обязательное поле (от 8 символов)
### POST `/api/v1/authUser`
Параметр | Описание
--- | ---
login | Обязательное поле (1-32 символа)
password | Обязательное поле (от 8 символов)
### GET `/api/v1/getUser`
Параметр | Описание
--- | ---
login | Обязательное поле (1-32 символа)
### PATCH `/api/v1/updateUserInfo`
Параметр | Описание
--- | ---
token | Обязательное поле (токен, который выдали при авторизации)
newInfo | Обязательное поле (без ограничений)
### DELETE `/api/v1/deleteUser`
Параметр | Описание
--- | ---
token | Обязательное поле (токен, который выдали при авторизации)