API design

Define what APIs are expected from the system...

Core Entities

Tweets
Users
Followers
Following
Timeline
Trends

Tweets API

Get a Tweet

GET twitter.com/api/1/tweets/:id
Request Header: [
  Authorization : Bearer <JWT Token>
]
Response : 200 OK
Respond Body : [Tweet instance]

Get Tweets by user

GET twitter.com/api/1/users/:id/tweets/
Request Header: [
  Authorization : Bearer <JWT Token>
]
Response : 200 OK
Respond Body : [a list of tweets]

Delete a tweet

DELETE twitter.com/api/1/tweets/:id
Request Header: [
  Authorization : Bearer <JWT Token>
]
Response : 200 OK

Post a Tweet

POST twitter.com/api/1/tweets
Request Header: [
  Authorization : Bearer <JWT Token>
]
Request Body: [A tweet]
Response: 201 Created

Update a tweet

PUT twitter.com/api/1/tweets
Request Header: [
  Authorization : Bearer <JWT Token>
]
Request Body: [A tweet]
Response: 200 OK

Retweet a tweet

POST twitter.com/api/1/users/:id/tweets/:source-tweet-id
Request Header: [
  Authorization : Bearer <JWT Token>
]
Response: 200 OK

Unlike/Like API

PATCH twitter.com/api/1/tweets/:id/like
Request Header: [
  Authorization : Bearer <JWT Token>
]
Request Body: [a tweet identifier, like/unlike]

Search Trends

GET twitter.com/api/1/trending/topics
Request Header: [
  Authorization : Bearer <JWT Token>
]
Response: 200 OK
Response Body: [a list of Trending tweets]

Get User API

GET twitter.com/api/1/users/:id/
Request Header: [
  Authorization : Bearer <JWT Token>
]
Response: 200 OK
Response Body: [an instance of user]

Get User by username

GET twitter.com/api/1/users/by/username/:name
Request Header: [
  Authorization : Bearer <JWT Token>
]
Response: 200 OK
Response Body: [a list of users]

Get following

GET twitter.com/api/1/users/:id/following/
Request Header: [
  Authorization : Bearer <JWT Token>
]
Response: 200 OK
Response Body: [a list of users]

Get followers

GET twitter.com/api/1/users/:id/followers/
Request Header: [
  Authorization : Bearer <JWT Token>
]
Response: 200 OK
Response Body: [a list of users]

Follow a user

GET twitter.com/api/1/users/:source-user-id/following/
Request Header: [
  Authorization : Bearer <JWT Token>
]
Response: 200 OK

UnFollow a user

GET twitter.com/api/1/users/:source-user-id/following/:target-user-id
Request Header: [
  Authorization : Bearer <JWT Token>
]
Response: 200 OK

Timeline API

PATCH twitter.com/api/1/users/:id/timeline?cursor={date}&region={region}
Request Header: [
  Authorization : Bearer <JWT Token>
]
Response : 200 OK
Response Body : [a list of 1000 tweets in reverse_chronological order]

Submissions

Displaying Solutions with Scores Ranging from 1 to 10

Submissions

Displaying Solutions with Scores Ranging from 1 to 10