Tweteroo

📝 Description

Tweteroo is a social network application, which is a clone of Twitter. This application is a project to train about Java Spring Boot

🚀 Technologies

• Java
• SpringBoot

📦 Installation

Clone the repository.

# https
$ git clone https://github.com/frreiro/tweteroo-api-java
# ssh
$ git clone git@github.com:frreiro/tweteroo-api-java.git

📌 Features

• User signup
• User create tweet
• Read all tweets with pagination
• Read a single user tweets

🔀 Routes

• POST /signup - Create a new User

  • headers: default
  • body:

    {
    	"username": "yourusername",
    	"avatar": "youravatarurl",
    }

  • response: OK

• POST /tweets - Post a user tweet

  • headers: default
  • body:

    {
    	"username": "yourusername",
    	"tweet": "lorem ipsum dolor sit amet",
    }

  • response: OK

• GET /tweets - Get tweet from all users with pagination, the size is always 5 tweets

  Query Params	type	Description
  none	none	first page, page = 0
  page	number	page number, starting with 0

  • headers: default
  • body: none
  • response:

  {
  	"content": [
  		{
  		"username": "yourusername",
  		"avatar": "useravatarurl",
  		"tweet": "lorem ipsum dolor sit amet",
  		}	
  	],
  	"pageable": {
  	"sort": {
  		"empty": false,
  		"sorted": true,
  		"unsorted": false
  		},
  	"offset": 0,
  	"pageNumber": 0,
  	"pageSize": 5,
  	"paged": true,
  	"unpaged": false
  	},
  	"totalPages": 0,
  	"totalElements": 0,
  	"last": true,
  	"size": 5,
  	"number": 0,
  	"sort": {
  		"empty": false,
  		"sorted": true,
  		"unsorted": false
  		},
  	"numberOfElements": 0,
  	"first": true,
  	"empty": true
  }
  

• GET /tweets/{USERNAME} - Get user tweets

  • headers: default
  • body: none
  • response:

  [
  	{
  	"username": "userusername",
  	"avatar": "useravatarurl",
  	"tweet": "lorem ipsum dolor sit amet",
  	}	
  ]

• GET /health - Get API health

  • headers: default
  • body: none
  • response: OK