Skip to content

TrimA74/SpringBoot-Swagger-Rest-API-for-Wine-Cellar

 
 

Repository files navigation

🍷 SpringBoot-Swagger Rest API

This is a school project for the course INFO806 Integration Continu given by Guillaume Jambet

REST Api to manage your wine cellar 🍷

You can checkout the Angular5 client

Overview

This project is using a boilerplate

Technologies

The following are the key technologies used in the project:

Running the Project

To run the project:

  1. Clone this repository
  2. Go to the root directory of the repository: cd ./YOUR-REPO-NAME
  3. Run the package Maven task: mvn package
  4. Go to the target directory
  5. Run the generated JAR file: java -jar <JAR-file>

Running the Project with IntelliJ IDEA Ultimate Edition for development purpose

To run the project:

  1. Clone the repository using the git integration of Intellij From the main menu, choose VCS | Checkout from Version Control | Git and then click Clone
  2. IntelliJ will ask you to create an IntelliJ IDEA project from the sources you have checked out, just click Yes
  3. Choose Import project from external model and select Maven
  4. Modify the needed parameters for your configuration and click Finish
  5. Using the Maven Projects tool window, run the maven build using package command
  6. Click now the Run application button to start Spring Boot application ( IntelliJ already added Spring boot config )
  7. Check http://localhost:8080

To view the generated Swagger UI documentation go to: http://localhost:8080/swagger-ui.html

To view the H2 Database http://localhost:8080/h2console/

  • Driver Class org.h2.Driver
  • JDBC Url jdbc:h2:mem:test
  • No username nor password are required to login into the H2 console.

h2-console

API Endpoints

api-swagger-documentation

About

🍷 REST API to manage wine cellar with Swagger-Springboot

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 100.0%