rest-api-with-local-database

REST API using Spring Boot and Java

LinkedIn

REST API using Spring Boot

This Project: REST API framework designed for website interface and retrieving data from MySQL Database
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Purpose
4. Roadmap
5. Contributing
6. Contact

About The Project

Built With

• Eclipse IDE for Eclipse Committers
• Spring Boot
• MySQL Workbench
• MySQL Installer
• Postman

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• an IDE or a text editor
• JDK 1.8+
• Maven 3+

Installation

1. Clone the repo

   git clone https://github.com/aazamuddin4/rest-api-with-local-database.git

2. Install Eclipse IDE for Eclipse Committers

3. Initializing a Spring Boot Project

   Go to start.spring.io and add below dependencies

   • Spring Data JPA
   • Spring Web
   • Spring Boot DevTools
   • MySQL Driver

   Once installed, open the maven project in Eclipse IDE

4. Install MySQL Installer with added product of

   • MySQL Server
   • MySQL Workbench
   • Connector/ODBC

5. Install MySQL Workbench GUI

   Create connection between the server created in the MySQL Installer

6. Install Postman

   Test the URL created in the APIcontroller.java (GET or POST)

Purpose

Application programming interface (API or web API) that conforms to the constraints of REST architectural style and allows for interaction with RESTful web services. REST stands for representational state transfer

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Email - andiazamuddin@gmail.com

Twitter - @aaxamuddin

LinkedIn Link: https://www.linkedin.com/in/aazamuddin4/