Skip to content

Welcome to my Api Rest with Spring Framework. 🔥🌈 A small work simulating a quite fake school structure.

License

Notifications You must be signed in to change notification settings

Ivan-Montes/SpringSchoolApiRest

Repository files navigation

🎓 SpringSchoolApiRest 🎓

Welcome to my Api Rest with Spring Framework. 🔥🌈 A small work simulating a quite fake school structure.

Table of contents

Installation

Just cloning or downloading the project.

Usage

  • Check and try it from you favorite IDE. Take advantage of Open API and Swagger UI hosted in http:https://localhost:8080/swagger-ui/index.html

  • Or you could use the jar file hosted in /target. For this, run these commands from the folder and send your HTTP request to localhost:8080

mvn clean package

java -jar school-api-rest-1.0.jar

Example of URL for and HTTP GET request in local environment

** Get a List of all teachers **
http:https://localhost:8080/api/teachers

**  Get a student according to an Id **
http:https://localhost:8080/api/students/2
  • Also, you can use Docker. Whether it is your flavor, first, from the inside of the main project folder, build the image using the settings from Dockerfile
docker build -t spring-school-api:latest .

Then create and run a container with, for instance, these settings

docker run --name spring-school-api-container -p 8080:8080 -d spring-school-api

Features

⚡ Spring Security full extra deluxe

⚡ Authentic Oauth2 with authentic GitHub authentication

⚡ JUnit test everywhere

Maintainers

Just me, Iván 😅

License

GPLv3 license


Java Maven Spring GitHub Eclipse SonarQube Docker GPLv3 license

About

Welcome to my Api Rest with Spring Framework. 🔥🌈 A small work simulating a quite fake school structure.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages