A demo project of channel messenger

Deployment

Steps to run this project:

1. Run npm install command
2. Run npm start command
3. Open http://localhost:3000/messages in browser

Unit testing

1. Run npm test command

API document

Get all channels

GET http://localhost:3000/channels

Result:

{
  "code": 0,
  "message": "success",
  "data": {
    "id": 1,
    "name": "xxxx"
  }
}

Create a channel

POST http://localhost:3000/channels

Body:

Name	Type	Optional
name	String	No

Get message list

GET http://localhost:3000/messages

Parameters:

Name	Type	Default	Optional
page	Int	1	Yes
page_size	Int	10	Yes
channel_id	Int	0	Yes

Result:

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "id": 1,
      "title": "hello world!",
      "content": "This is my first message.",
      "createdAt": "2022-08-08T08:28:42.000Z",
      "updatedAt": "2022-08-08T08:28:42.000Z",
      "channel": {
        "id": 1,
        "name": "Life",
        "createdAt": "2022-08-08T08:28:42.000Z",
        "updatedAt": "2022-08-08T08:28:42.000Z"
      }
    }
  ],
  "total": 4,
  "page_size": 10,
  "page": 1,
  "total_page": 1
}

Create a message

POST http://localhost:3000/messages

Body:

Name	Type	Optional
channel_id	Int	No
title	String	No
content	String	No