API / Backend OPOWER

JPA + Hibernate + MySQL + Swagger with Spring Boot

Istic School project

version 0.0.1 [development]

Project in Distributed information system (SIR [Système d'information répartie] : french)

This is a backend API OPOWER.

Allows you to compare the consumption of your home's electrical equipment with your friends.

(Illustration : screen example)

Getting Started

• Download this project.

• Open with IntelliJ.

• Open for exemple Wamp and create database name.

• Change database name in resources/application.properties.

• Change "spring.jpa.hibernate.ddl-auto" parameter in "resources/application.properties" to "update" if you want keep data.

• Click on start. It's working.

• Beginin click on main-controller command in WEB UI http://localhost:8080/swagger-ui.html.

• Origin the "spring.jpa.hibernate.ddl-auto" paramter in "resources/application.properties" is on create-drop. You can create fictif data in MainController command.

Prerequisites

To have data base sql and Maven installed. If not show the dependency in file.

Installing

Project make on IntelliJ.

You must to make an MySql database(empty). You can editing the application.properties for database name, login and password of your database.

Running

• Launch your database MySql or launch server with bach script sh. (here is MySql)

• Run Main class

• open Postman or your navigator (here : http://localhost:8080/swagger-ui.html)

Built With

IntelliJ

• Maven - Dependency Management
• [Hibernate]
• [Swagger]
• [Spring Boot]

Authors

• Cavron Jérémy - Initial work - Portfolio

Acknowledgments

• Project school. Istic - university - Rennes 1.

• API documentation JSON http://localhost:8080/v2/api-docs/

• API documentation WEB UI http://localhost:8080/swagger-ui.html