Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shaikrasheed99/springboot-twitter

Features of Twitter using Spring Boot.
https://github.com/shaikrasheed99/springboot-twitter

java postgresql rest-api spring-boot spring-mvc tdd tdd-java

Last synced: 29 days ago
JSON representation

Features of Twitter using Spring Boot.

Host: GitHub
URL: https://github.com/shaikrasheed99/springboot-twitter
Owner: shaikrasheed99
Created: 2022-10-28T17:24:45.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2022-11-08T17:38:03.000Z (over 2 years ago)
Last Synced: 2024-11-14T04:26:34.226Z (3 months ago)
Topics: java, postgresql, rest-api, spring-boot, spring-mvc, tdd, tdd-java
Language: Java
Homepage:
Size: 156 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Spring Boot Twitter

## Gradle based spring boot application which provide APIs to implement few features of twitter using test driven development.

## Features of the Application
- Create User
- Read Users by User id
- Post a Tweet
- Read Tweets of User
- Read Tweet of User by Tweet Id
- Follow a User
- Read Followers of a User
- Read Follows of a User
- Unfollow a User

## Users APIs

### Users - Create a User

* Request
```
POST /users
Host: localhost:3000
Content-Type: application/json
{
"id": 1,
"name": “Ironman”,
}
```
* Response
```
Status code: 201 Created
Body:
{
"data": {
"id": 1
}
}
```

### Users - If we try to provide empty User’s name in the request body

* Request
```
POST /users
Host: localhost:3000
Content-Type: application/json
{
"id": 1
}
```
* Response
```
Status code: 400 Bad Request
Body:
{
"error": {
"message": "User name should not be empty!"
}
}
```

### Users - If the User is already exists

* Request
```
POST /users
Host: localhost:3000
Content-Type: application/json
{
"id": 1,
"name": “Ironman”,
}
```
* Response
```
Status code: 400 Bad Request
Body:
{
"error": {
"message": "User is already exists with id = 1”
}
}
```

### Users - Get User details by User Id

* Request
```
GET /users/{1}
Host: localhost:3000
```
* Response
```
Status code: 200 OK
Body:
{
"data": {
"id": 1,
"name": "Ironman"
}
}
```

### Users - If we try to provide not existed User Id in the path url

* Request
```
GET /users/{1}
Host: localhost:3000
```
* Response
```
Status code: 404 Not Found
Body:
{
"error": {
"message": "User not found with id = 1"
}
}
```

## Tweets APIs

### Tweets - Post a Tweet

* Request
```
POST /users/{1}/tweets
Host: localhost:3000
Content-Type: application/json
{
"description": "This is my first tweet!”
}
```
* Response
```
Status code: 201 Created
Body:
{
"data": {
"tweet_id": 1
}
}
```

### Tweets - If we try to provide empty Tweet’s description in the request body

* Request
```
POST /users/{1}/tweets
Host: localhost:3000
Content-Type: application/json
{
"description": "”
}
```
* Response
```
Status code: 400 Bad Request
Body:
{
"error": {
"message": "Description should not be null or empty!"
}
}
```

### Tweets - If we try to provide not existed User Id in the path url

* Request
```
POST /users/{1}/tweets
Host: localhost:3000
Content-Type: application/json
{
"description": “This is my first tweet!”
}
```
* Response
```
Status code: 404 Not Found
Body:
{
"error": {
"message": "User not found with id = 1”
}
}
```

### Tweets - Get Tweets by User Id

* Request
```
GET /users/{1}/tweets
Host: localhost:3000
```
* Response
```
Status code: 200 OK
Body:
{
"data": [
{
"id": 22,
"description": "This is my first tweet!",
"authorId": 1,
"authorName": "Ironman"
},
{
"id": 23,
"description": "This is my second tweet!",
"authorId": 1,
"authorName": "Ironman"
}
]
}
```

### Tweets - Get Tweet details of a User by Tweet Id

* Request
```
GET /users/{1}/tweets/{22}
Host: localhost:3000
```
* Response
```
Status code: 200 OK
Body:
{
"data": {
"id": 22,
"description": "This is my first tweet!",
"authorId": 1,
"authorName": "Ironman"
}
}
```

### Tweets - If we provide not existed Tweet Id in the path url

* Request
```
GET /users/{1}/tweets/{220}
Host: localhost:3000
```
* Response
```
Status code: 404 Not Found
Body:
{
"error": {
"message": "Tweet is not found with tweet id = 220”
}
}
```

### Tweets - If we try to find another User’s Tweet details by Tweet Id in path url

* Request
```
GET /users/{1}/tweets/{22}
Host: localhost:3000
```
* Response
```
Status code: 403 Forbidden
Body:
{
"error": {
"message": "Author cannot see another author's complete tweet details!"
}
}
```

## Follows APIs

### Follows - Follow a User

* Request
```
POST /users/{1}/follow
Host: localhost:3000
Content-Type: application/json
{
"followsId": 2
}
```
* Response
```
Status code: 200 OK
Body:
{
"data": {
"followerId": 1,
"followsId": 2
}
}
```

### Follows - If we try to provide same User Id as follower Id and follows Id to follow

* Request
```
POST /users/{1}/follow
Host: localhost:3000
Content-Type: application/json
{
"followsId": 1
}
```
* Response
```
Status code: 400 Bad Request
Body:
{
"error": {
"message": "User id = 1 cannot follow itself!"
}
}
```

### Follows - If we try to provide not existed User Id in the path url as follower Id

* Request
```
POST /users/{1}/follow
Host: localhost:3000
Content-Type: application/json
{
"followsId": 2
}
```
* Response
```
Status code: 404 Not Found
Body:
{
"error": {
"message": "User is not found with follower Id = 1"
}
}
```

### Follows - If we try to provide not existed User Id in the request body as follows Id

### Follows - If we try to provide User Id as follows Id who is already following

* Request
```
POST /users/{1}/follow
Host: localhost:3000
Content-Type: application/json
{
"followsId": 2
}
```
* Response
```
Status code: 400 Bad Request
Body:
{
"error": {
"message": "User Id = 1 is already following User Id = 2”
}
}
```

### Follows - Get Followers of a User by User Id

* Request
```
GET /users/{1}/followers
Host: localhost:3000
```
* Response
```
Status code: 200 OK
Body:
{
"data": {
"count": 2,
"followers": [
{
"name": "Thanos",
"id": 4
},
{
"name": “Thor”,
"id": 2
}
]
}
}
```

### Follows - If we try to provide not existed User Id in the path url

* Request
```
GET /users/{1}/followers
Host: localhost:3000
```
* Response
```
Status code: 404 Not Found
Body:
{
"error": {
"message": "User not found with id = 1”
}
}
```

### Follows - Get Follows of a User by User Id

* Request
```
GET /users/{1}/follows
Host: localhost:3000
```
* Response
```
Status code: 200 OK
Body:
{
"data": {
"count": 4,
"follows": [
{
"name": "Spider Man",
"id": 5
},
{
"name": "Captain",
"id": 3
},
{
"name": "Thor",
"id": 2
},
{
"name": "Thanos",
"id": 4
}
]
}
}
```

### Follows - If we try to provide not existed User Id in the path url

* Request
```
GET /users/{1}/follows
Host: localhost:3000
```
* Response
```
Status code: 404 Not Found
Body:
{
"error": {
"message": "User not found with id = 1”
}
}
```

### Follow - Unfollow a User

* Request
```
POST /users/{1}/unfollow
Host: localhost:3000
Content-Type: application/json
{
"followsId": 2
}
```
* Response
```
Status code: 200 OK
Body:
{
"data": {
"message": "User Id = 1 unfollowed User Id = 2"
}
}
```

### Follows - If we try to provide same User Id as follower Id and follows Id to unfollow

* Request
```
POST /users/{1}/unfollow
Host: localhost:3000
Content-Type: application/json
{
"followsId": 1
}
```
* Response
```
Status code: 400 Bad Request
Body:
{
"error": {
"message": "User id = 1 cannot unfollow itself!"
}
}
```

### Follows - If we try to provide User Id as follows Id who is not following

* Request
```
POST /users/{1}/unfollow
Host: localhost:3000
Content-Type: application/json
{
"followsId": 2
}
```
* Response
```
Status code: 400 Bad Request
Body:
{
"error": {
"message": "User Id = 1 is not following User Id = 2”
}
}
```