chatapi-server v1.1.0

Setting up the server

You will find a file called config.json in this section you will find what each of this options do.

• list.size The size of the list of messages, by default is 5
• info.MOTD The Message Of The Day
• md.serverWelcome When a user joins the server will send this message by MD
• port The server port

Running the server

Run server.js

API

Getting a user token and joining the user

• Request:

  POST /register

  Body:

  {
      "username":<username>
  }

• Response:

  Body:

  {
      "username":<username>,
      "token":<token>
  }

Disconnecting the user

• Request:

  POST /disconnect

  Body:

  {
      "token":<token>
  }

• Response:

  Body:
  ```JSON
  {
      "message":"User deleted"
  }
  ```

  Getting the MOTD

• Request:

  GET /info/MOTD

• Response:

  Body:

  {
          "MOTD":<MOTD>
  }

Getting the last message

• Request:

  GET /chat

• Response:

  Body:

  {
          "content":<content>,
          "user":<user>
  }

Getting a list of the last messages

• Request:

  GET /chat/list

• Response:

  Body:

  {
      "messages": [
          {
              "content":<content>,
              "user":<user>
          },
          {
              "content":<content>,
              "user":<user>
          },
          {
              "content":<content>,
              "user":<user>
          },
          {
              "content":<content>,
              "user":<user>
          },
          {
              "content":<content>,
              "user":<user>
          }
      ]        
  }

  The size of the array depends of the limit in config and the amount of messages that has been sent to the server

Sending a message

• Request:

  POST /chat

  Body:

  {
      "token":<token>,
      "content":<content>
  }

• Response:

  Body:

  {
      "username":<username>,
      "content":<content>
  }

Sending in MD

• Request:

  POST /chat/md

  Body:

  {
      "token":<token>,
      "to":<reciever>,
      "content":<content>
  }

• Response:

  Body:

  {
      "content":<content>,
      "sender":<sender>
  }

  (This is the message that recieves the target)

Getting the last MD message

• Request:

  GET /chat/md/check?token=<token>

• Response:

  Body:

  {
      "content":<content>,
      "sender":<sender>
  }