From 44c7988429575896d8e18b10a6b505b9507c3f1c Mon Sep 17 00:00:00 2001 From: root Date: Sat, 10 Aug 2024 01:54:28 +0800 Subject: [PATCH] Add description to API endpionts --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 56676ed..3536fd3 100644 --- a/README.md +++ b/README.md @@ -7,29 +7,43 @@ ## Документация 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` +Обновление поля info у пользователя + Параметр | Описание --- | --- token | Обязательное поле (токен, который выдали при авторизации) newInfo | Обязательное поле (без ограничений) + ### DELETE `/api/v1/deleteUser` +Удаление пользователя + Параметр | Описание --- | --- token | Обязательное поле (токен, который выдали при авторизации)