Git Product home page Git Product logo

suaichatserver's Introduction

SUAIChatServer

Сервер для простенького чата на Kotlin + Spring. Разрабатывался специально для подготовки сборной ГУАП к региональному этапу WorldSkills по мобильной разработке. На этом конкурсе в задании всегда есть работа с REST API. Я предложил написать простенький чат. Да, нормальный серер делается иначе, многие решения (авторизация, хранение сообщений, обмен данными с клиентом) необходимо делать более абстрактно и более серьёзно. Например использовать WebSockets или какой-нибудь сервис (к примеру Firebase) для передачи информации в реальном времени на клиент. К тому же это мой первый проект на Spring и третий на Kotlin. Прошу не судить очень строго )

Документация по API сервера SUAI Chat Application

Сервер с API доступен по адресу fspobot.tw1.ru:8080 Сервер может возвращать стандартные коды запросов, например: HTTP STATUS CODE 403 (UNAUTHORIZED)

Авторизация ( /auth )

Регистрация ( /register )

Метод: POST Аргументы запроса: нет Параметры заголовка: нет Тело запроса: JSON в следующем формате: { "firstName": "name1", "lastName": "name2", "email": "[email protected]", "password": "anypassword" }

Возвращаемые значения: HTTP STATUS CODE 200 - в случае успеха, а также JSON {"state": "ok", "token":"acces_token" }

Авторизация ( /login )

Метод: POST Аргументы запроса: нет Параметры заголовка: нет Тело запроса: JSON в следующем формате: { "email": "[email protected]", "password": "anypassword" }

Возвращаемые значения: HTTP STATUS CODE 200 - в случае успеха, а также JSON { "state": "ok", "token": "acces_token" }

Выход ( /logout )

Метод: POST Аргументы запроса: нет Параметры заголовка: Токен Authorization Тело запроса: нет Возвращаемые значения: HTTP STATUS CODE 200 - в случае успеха

Чаты ( /chats )

Получение списка зарегестрированных пользователей ( /allusers )

Метод: GET Аргументы запроса: нет Параметры заголовка: Токен Authorization Тело запроса: нет Возвращаемые значения: HTTP STATUS CODE 200 - в случае успеха, а также JSON в следующем формате [ { "firstName": "Andrey", "lastName": "Bogdanov", "id": 1 }, { "firstName": "Alex", "lastName": "Titov", "id": 2 } ]

Получение списка чатов пользователя ( /myChats )

Метод: GET Аргументы запроса: нет Параметры заголовка: Токен Authorization Тело запроса: нет Возвращаемые значения: HTTP STATUS CODE 200 - в случае успеха, а также JSON в следующем формате [ { "chatIconName": null, "chatName": "Тупой чат", "id": 1 }, { "chatIconName": "fjdsaljnf21e1n421m.png", "chatName": " чат", "id": 2 }, ]

Создание чата ( /createChat )

Метод: POST Аргументы запроса: нет Параметры заголовка: токен Authorization Тело запроса: { "chatName": "_MY_CHAT_NAME_", "userIds": [1, 2, 3, 4 ... ] } Возвращаемые значения: HTTP STATUS CODE 200 - в случае успеха, а также JSON в следующем формате { "chatIconName": null, "chatName": "Тупой чат", "id": 1, "users": [ { "firstName": "firstuser", "lastName": "12345", "id": 2 }, { "firstName": "secondU2ser", "lastName": "12345", "id": 3 } ... }

Отправка сообщения ( /sendMessage )

Метод: POST Аргументы запроса: нет Параметры заголовка: токен Authorization Тело запроса: { "chatId": 1, "message": "Any text in message" } Возвращаемые значения: HTTP STATUS CODE 200 - в случае успеха, а также JSON в следующем формате: { "chatIconName": null, "chatName": "Тупой чат", "id": 1, "users": [ { "firstName": "firstuser", "lastName": "12345", "id": 2 }, { "firstName": "secondU2ser", "lastName": "12345", "id": 3 } ... }

Получение сообщений ( /getMessages )

Метод: GET Аргументы запроса: chatId - id чата из которого вытаскиываем сообщения Параметры заголовка: токен Authorization Тело запроса: - Возвращаемые значения: HTTP STATUS CODE 200 - в случае успеха, а также JSON в следующем формате: { "chat": { "chatIconName": null, "chatName": "Тупой чат", "id": 1, "users": [ { "firstName": "firstuser", "lastName": "12345", "id": 2 }, { "firstName": "secondU2ser", "lastName": "12345", "id": 3 } ... }, "user": { "firstName": "firstuser", "lastName": "12345", "id": 2 }, "content": "Message text", "date": Date object same as java.util.date }

suaichatserver's People

Contributors

mrlargha avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.