Skip to content

An API created with Java and Spring Boot, Spring Data JPA and Lombok to manage a pizzeria, with connection to MySQL databases. Includes unit tests with Junit5

License

Notifications You must be signed in to change notification settings

leiberbertel/Java-Pizzeria-API

Repository files navigation

pizzeria API

This is an API for the basic operation of a pizzeria:

Static Badge Static Badge

Running the API with Docker

To run the API using Docker, follow these steps:

  1. Clone the Repository (if you haven't already):

    git clone https://github.com/leiberbertel/java-pizzeria.git
    cd java-pizzeria
    
  2. Build the Docker Image:
    Make sure Docker is installed on your machine. Build the Docker image with:

    docker build -t pizzeria-api
  3. Run the Docker Container:
    After building the image, run the container with:

    docker run -p 8080:8080 pizzeria-api
  4. Access Swagger UI:
    Once the container is running, you can view the Swagger UI documentation at http://localhost:8080/swagger-ui/index.html#/.

Running the API Without Docker

To run the API, you will need JDK version 17 installed on your machine. Download it here:

  1. Clone the repository (if you haven't already):

    git clone https://github.com/leiberbertel/java-pizzeria.git
    cd leiber-pizzeria
  2. Build and Run the Application:

    ./gradlew build
    ./gradlew bootRun

    On OS windows:

    gradlew.bat build
    gradlew.bat bootRun

The Spring Boot application will launch and be running on port 8080

All endpoints and schemas are documented using Swagger UI. You can view the documentation at http://localhost:8080/swagger-ui/index.html#/, which is the default endpoint for the Swagger UI.

Built with 🛠

  • Java version 17 - Language used
  • Lombok - Tertiary dependency
  • Mysql - Database Engine
  • Spring Framework - Framework used
  • Spring Data JPA - Dependency on data manipulation
  • Springdoc - Dependency on API documentation

About

An API created with Java and Spring Boot, Spring Data JPA and Lombok to manage a pizzeria, with connection to MySQL databases. Includes unit tests with Junit5

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published