News Service Rest API

Back-end architecture of news service, based on mysql and spring boot. It contains various news related APIs.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Maven
Java
MySQL

Installing

Clone & Install

Clone the repo: git clone [email protected]:rajnikant7008/RestAPI.git
Install dependencies: mvn clean compile install -DskipTests

MySql Queries

Configure mysql user name and password in : src/main/resources/application.properties
Run queries from : src/main/resources/release-sql/schema.1.0.sql

Deployment

Using Console

Start the server: mvn spring-boot:run

Using Code Editor (IntelliJ IDEA or Eclipse)

Run: src/main/java/com/rajnikant/springAPI/SpringApiApplication.java

Testing the API

Using Postman

Create valid request and fire.

Using Swagger

Start the server and open: http://localhost:8080
And hit APIs as listed below.

Built With

• Spring Boot - The web/application framework used
• SpringFox - API documentation
• Maven - Dependency Management
• MySQL - Used for persistent storage
• Hibernate - Object/Relational Mapping (ORM) framework

License

This project is licensed under the Apache License - see the LICENSE.md file for details