README.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "17470fda",
   "metadata": {},
   "source": [
    "### Messenger API"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "9cd1dad3",
   "metadata": {},
   "source": [
    "Project structure:\n",
    "\n",
    "- The project is built according to the Microservice architecture pattern (each microservice is stateless)\n",
    "- List of microservices:\n",
    "    1. User service: (endpoints):\n",
    "        - (POST) /auth : authentication endpoint (declared in the AuthFilter)\n",
    "            - Parameters: ?username=user&password=pwd\n",
    "            - Request body: none\n",
    "            - Authentication result: Bearer token (sent as a response header) \n",
    "        - (GET) /user/{id}: get user by id:\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - user auth token\n",
    "            - Response body: MessengerUserDTO (JSON) or HTTP 403 Forbidden or HTTP 400 BadRequest\n",
    "        - (GET) /user?username=name - get user by username\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - user auth token\n",
    "            - Response body: MessengerUserDTO (JSON) or HTTP 403 Forbidden or HTTP 400 BadRequest\n",
    "        - (POST) /user - add new user\n",
    "            - auth: no authentication (anonymous)\n",
    "            - Request body: MessengerUserDTO (JSON)\n",
    "            - Response body: MessengeruserDTO with encrypted password and userID\n",
    "        - (PUT) /user ?username=%s OR ?user-id=%d: modify user data\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - user auth token\n",
    "            - Request body: MessengerUserDTO (JSON)\n",
    "            - Response body: MessengeruserDTO with modified data (and encrypted password)\n",
    "        - (DELETE) /user ?username=%s OR ?user-id=%d: delete user\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - user auth token\n",
    "            - Response: HTTP 200 OK or HTTP 403 Forbidden or HTTP 400 BadRequest\n",
    "    1. Chat service: (endpoints):\n",
    "        - (POST) /auth ?user-access-token=%s&chat-name=%s: chat authentication endpoint (declared in the AuthFilter)\n",
    "            - authorize a user (user-access-tokes) for a specific chat (or give the authority to create chats, if chat name is not specified)\n",
    "            - Parameters: user-access-token: user service access token; chat-name: chat name or \\<empty>\n",
    "            - Request body: none\n",
    "            - Authentication result: Bearer token (sent as a response header) \n",
    "        - (GET) /chats ?username=%s OR ?user-id=%d: get chats by user id\n",
    "            - RequestBody: PageRequestDTO (Pageable)\n",
    "            - ResponseBody: Page\\<Chat> (JSON)\n",
    "        - (POST) /chat: create a new chat\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - chat user auth token (should have the authority to create chats)\n",
    "            - RequestBody: ChatDTO (JSON)\n",
    "            - ResponseBody: Chat (JSON) or HTTP 403 Forbidden or HTTP 400 BadRequest\n",
    "        - (GET) /chat: get chat info\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - chat user auth token (should have the authority to read chat info)\n",
    "            - Parameters: ?chat-id=%d OR ?chat-name=%s\n",
    "            - Response body: Chat (JSON)\n",
    "        - (PUT) /chat: modify chat info:\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - chat user auth token (should have the authority to modify chat info)\n",
    "            - Request body: ChatDTO\n",
    "            - Response body: Chat (JSON) or HTTP 403 Forbidden or HTTP 400 BadRequest\n",
    "        - (POST) /chat/users: add a user to a chat\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - chat user auth token (should have the authority to add new users)\n",
    "            - Request Body: ChatUserDTO (JSON)\n",
    "            - Response body: ChatUser (JSON) or HTTP 403 Forbidden or HTTP 400 BadRequest\n",
    "        - (PUT) /chat/users: modify chat user data\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - chat user auth token (should have the authority to modify user info)\n",
    "            - Parameters: ?chat-id=%d AND ?user-id=%s\n",
    "            - Request body: ChatUserDTO (JSON)\n",
    "            - Response body: ChatUser (JSON) or HTTP 403 Forbidden or HTTP 400 BadRequest\n",
    "        - (DELETE) /chat/users: delete chat user\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - chat user auth token (should have the authority to delete chat user)\n",
    "            - Parameters: ?chat-id=%d AND ?user-id=%s - id of chat user to delete\n",
    "            - Response body: ResponseEntity\\<String> : delete message; or HTTP 403 Forbidden or HTTP 400 BadRequest\n",
    "        - (GET) /chat/users : get chat users by chat\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - chat user auth token (should have the authority to read chat users)\n",
    "            - Parameters: ?chat-id=%d OR ?chat-name=%s\n",
    "            - Response body: Page\\<ChatUser> - chat users; or HTTP 403 Forbidden or HTTP 400 BadRequest\n",
    "            \n",
    "    2. Message service: (endpoints):\n",
    "        - (POST) /auth: authentication endpoint (not implemented, chat service authentication is used)\n",
    "        - (POST) /message: post a message\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - chat user auth token (should have the authority to send messages)\n",
    "            - Request body: MessageDTO (JSON)\n",
    "            - Response body: ChatMessage (JSON) or HTTP 403 Forbidden or HTTP 400 BadRequest\n",
    "        - (GET) /message : get chat message by id\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - chat user auth token (should have the authority to read messages)\n",
    "            - Request body: ChatMessageId (chat id, user id, submission time)\n",
    "            - Response body: ChatMessage or HTTP 403 Forbidden or HTTP 400 BadRequest\n",
    "        - (GET) /messages : find all chat messages by chat\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - chat user auth token (should have the authority to read messages)\n",
    "            - Parameters: ?chat-id=%d OR ?chat-name=%s\n",
    "            - Request body: PageRequestDTO (Pageable, JSON)\n",
    "            - Response body: Page\\<ChatMessage> or HTTP 403 Forbidden or HTTP 400 BadRequest\n",
    "        - (PUT) /message: edit chat message\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - chat user auth token (should have the authority to edit messages)\n",
    "            - Request body: MessageDTO (edited message, JSON)\n",
    "            - Response body: ChatMessage (updated message, JSON)\n",
    "        - (DELETE) /message: delete message by id:\n",
    "            - \"Authentication\" header: \"Bearer %s\", %s - chat user auth token (should have the authority to delete messages)\n",
    "            - Request body: ChatMessageId (chat id, user id, submission time)\n",
    "            - Response: HTTP 200 OK or HTTP 403 Forbidden or HTTP 400 BadRequest\n",
    "- Database connection:\n",
    "    - ENV \"mysql-host\": environment variable (default: localhost): MySQL database host\n",
    "    - username & password: specified in the config file: $application.yml$\n",
    "    - driver: $\\textit{com.mysql.cj.jdbc.Driver}$\n",
    "- Spring Boot profiles:\n",
    "    - \\#todo add description"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.10.7"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}