$ docker run -d -p 3000:3000 --name chat_server aleshkovskiy/chat_server
Данная документация предназначена для ознакомления с REST API серверной части приложения.
Общий вид запроса к сервисам:
http://localhost:3000/[действие]/[объект]/{объект*}.
*Не обязательное поле, см. подробно в примерах ниже.
Сервис для отправки сообщения:
POST-запрос по URL http://localhost:3000/send/message
Тело запроса:
{
from: {string} - От кого отправленной сообщение,
to: {string} - Кому отправленно сообщение,
text: {string} - Текст сообщения
}
Ответ от сервиса:
{
"status": {boolean} status - статус ответа,
"messages": {array} messages - Список всех сообщений с отправленным
}
Сервис для получения последних N сообщений:
POST-запрос по URL http://localhost:3000/read/messages/last
Тело запроса:
{
count: {number} - Кол-во последних сообщений, которое нужно получить
}
Ответ от сервиса:
{
"status": {boolean} status - статус ответа,
"messages": {array} messages - Список последних N сообщений
}
Сервис для получения сообщений за определенный период:
POST-запрос по URL http://localhost:3000/read/messages/period
Тело запроса:
{
start: {string} - Начало периода в формате (ГГГГ ММ ДД ЧЧ ММ СС),
end: {string} - Конец периода в формате (ГГГГ ММ ДД ЧЧ ММ СС)
}
Ответ от сервиса:
{
"status": {boolean} status - статус ответа,
"messages": {array} messages - Список всех сообщений за указанный период
}
Content type
Image
Digest
Size
260 MB
Last updated
over 8 years ago
docker pull aleshkovskiy/chat_server