News api

Rest api for news application

App here: https://app-news-api.azurewebsites.net

Tools used

• Spring
  • Spring Boot
  • Spring Security
• PostgreSQL Database
• Bing Web Search API

Responsibilities

• User authentication
• Database management
• Communication with Bing Web Search API

Endpoints

User authentication

• POST /api/login
  • Enables login by username and password (in request body)
  • Returns user data (username and auth token)
• POST /api/register
  • Creates new user with given username and password (in request body)
  • Returns username
• POST /api/logout
  • Logs user out
• GET /api/user
  • Retrieves currently logged-in user data

Storing user data

• GET /api/phrase
  • Returns all observed by user phrases
• POST /api/phrase/
  • Adds new phrase to user's observed phrases
  • Takes new phrase in request body
  • Returns created PhraseEntity object - new observed phrase and username
• DELETE /api/phrase
  • Deletes user's observed phrase
  • Takes phrase to delete in request body

Comunication with Bing API

• GET /api/search
  • Returns an array of news related to user's observed phrases
  • Takes index of results' page as page query parameter
  • Takes amount of news related to each phrase as count query parameter
• GET api/search/{phrase}
  • Returns an array of news related to given phrase
  • Takes searched keyword as path variable
  • Takes index of results' page as page query parameter
  • Takes amount of news related to the phrase as count query parameter