Define REST API

[doanduyhai]

TBD

[doanduyhai]

• User Management
  • Create: POST /users/create { "login": "jdoe", "firstname": "John", "lastname": "DOE", "nickname": "johnny_cash", "password": "whatever", "email": "jdoe@fake.com", "bio": "I am John DOE, what else ?" }
  • Login: POST /users/login { "login": "jdoe", "password": "whatever" }
  • Change password: PUT /users/password { "login": "jdoe", "password": "whatever", "new-password": "new!" }
  • List users: GET /users?fromUserLogin=jdoe&fetchSize=10
  • fromUserLogin: start listing from this login, OPTIONAL
  • fetchSize: limit the search to fetchSize, OPTIONAL
  • List users room by pages: GET /users/rooms?fromRoomName=games&fetchSize=10
  • fromRoomName: start listing from this room name, OPTIONAL
  • fetchSize: limit the search to fetchSize, *OPTIONAL
• Chat room management
  • Create new room: POST /rooms { "room-name": "games", "direct-chat": false, "private-room": true, "creator": {"login": "jdoe", "firstname": "John","lastname": "DOE","nickname": "johnny_cash"} }
  • Get room by name: GET /rooms/{room_name}
  • List all rooms by page: GET /rooms/list?fromRoomName=games&fetchSize=10
  • fromRoomName: start listing from this room name, OPTIONAL
  • fetchSize: limit the search to fetchSize, *OPTIONAL
  • Add user to existing room: PUT /rooms/user { "room": {"room-name":"games", "creator":"jdoe"}, "participant": {"login": "hsue", "firstname": "Helen","lastname": "SUE","nickname": "helena"} }
  • Remove user from existing room: DELETE /rooms/user { "room": {"room-name":"games", "creator":"jdoe"}, "participant": {"login": "hsue", "firstname": "Helen","lastname": "SUE","nickname": "helena"} }
• Chat Message Management
  • Post new message: POST /messages/{roomName} { "author": "jdoe", "content": "bla bla bla" }
  • Update last message in a room: PUT /messages/{roomName} { "author": "jdoe", "content": "bla bla bla" }
  • Fetch messages in a room, by page, starting from a message: GET /messages/{roomName}?fromMessageId=xxx&fetchSize=10
  • fromMessageId: start listing messages from this message Id, OPTIONAL
  • fetchSize: limit the search to fetchSize, OPTIONAL

[mimiiix]

Just a question regarding the api that lists the rooms belonging to a specific user with a given login. Why are we browsing the rooms api to do so? We could do something like :

List users room by pages: GET /users/rooms?fromRoomName=games&fetchSize=10

fromRoomName: start listing from this room name, OPTIONAL
fetchSize: limit the search to fetchSize, OPTIONAL

What do you think ? @doanduyhai maybe your modelisation is constraining the api ?

[mimiiix]

Slight remark but completely personal. I dislike camel case in json payloads, i find it less readable. We could put a dash separator ?

[mimiiix]

Here i think you wanted to put GET instead of PUT to list users :)

List users: GET /users?fromUserLogin=jdoe&fetchSize=10

fromUserLogin: start listing from this login, OPTIONAL
fetchSize: limit the search to fetchSize, OPTIONAL

[doanduyhai]

List users: GET /users?fromUserLogin=jdoe&fetchSize=10 --> Fixed, thanks

[doanduyhai]

"Just a question regarding the api that lists the rooms belonging to a specific user with a given login. Why are we browsing the rooms api to do so?" --> You're right, we could move this feature into the /users API.

[doanduyhai]

"I dislike camel case in json payloads, i find it less readable. We could put a dash separator ?" --> Easy, I'll add @JsonProperty to the fields

[mimiiix]

@doanduyhai :+1: