Spring-boot Rest API

This documentation is both oriented to information to describe the functionalites of the projet and also oriented to understading, to explain the tools and models behind it in form of discursive and visual explanation. This documentation does not cover How-to guides or tutorials

---

📝 Table of Contents

• About
• Getting Started
• Functionalities
• Layout
• Documentation
• Built Using
• Tests
• Authors

💻 About

Voll.med is a fictional medical clinic that needs an application for appointment management. The application should have features that allow the registration of doctors and patients, as well as scheduling and canceling appointments.

🏁 Getting Started and Installation

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

IntelliJ IDEA

1. Open IntelliJ IDEA and select File > Open....
2. Choose the java-maven-starter-project directory and click OK.
3. Select File > Project Structure... and ensure that the Project SDK and language level are set to use Java 17.
4. Open the Maven view with View > Tool Windows > Maven.
5. In the Maven view, under Plugins > dependency, double-click the dependency:unpack goal. This will unpack the native libraries into $USER_HOME/.arcgis.
6. In the Maven view, run the compile phase under Lifecycle and then the exec:java goal to run the app.

Eclipse

1. Open Eclipse and select File > Import.
2. In the import wizard, choose Maven > Existing Maven Projects, then click Next.
3. Select the java-maven-starter-project as the project root directory.
4. Click Finish to complete the import.
5. Select Project > Properties . In Java Build Path, ensure that under the Libraries tab, Modulepath is set to JRE System Library (JavaSE-11). In Java Compiler, ensure that the Use compliance from execution environment 'JavaSE-11' on the 'Java Build Path' checkbox is selected.
6. Right-click the project in the Project Explorer or Package Explorer and choose Run As > Maven Build.... In the Edit Configuration dialog, create a new configuration with name unpack. In the Goals field, enter dependency:unpack. Click Run to run the goal. This will unpack the native libraries into $USER_HOME/.arcgis.
7. Again, create a new run configuration with name run. In the Goals field, enter compile exec:java. Click Run to run the goal. The app should compile and launch the JavaFX window.

Command Line

1. cd into the project's root directory.
2. Run ./mvnw dependency:unpack on Linux/Mac or mvnw.cmd dependency:unpack on Windows to unpack the native libraries to $USER_HOME/.arcgis.
3. Run ./mvnw compile exec:java on Linux/Mac or mvnw.cmd compile exec:java on Windows to run the app.

Prerequisites

See the Java Maps SDK system requirements.

Functionalities

• CRUD de doctors;
• CRUD de pacients;
• Scheduling of appointments;
• Canceling of appointments.

🎨 Layout

The layout of the mobile application is available at this link: Figma

---

📄 Documentação

The documentation for this application can be accessed here: Trello

---

🔧 Running the tests

On /src/test run selected package

Break down into the tests

These tests ensure that the ConsultaController behaves correctly in different scenarios, handling both invalid and valid input. The use of Spring's testing annotations and features like @WithMockUser, @AutoConfigureMockMvc, and @AutoConfigureJsonTesters helps set up the necessary environment for testing Spring MVC controllers and JSON serialization, and also ensures that the MedicoRepository correctly queries the database and returns the expected results when checking the availability of doctors for consultations on specific dates and times.

⛏️ Built Using

• Java 17
• Spring Boot 3
• Maven
• MySQL
• Hibernate
• Flyway
• Lombok

✍️ Authors

• @andredias - Idea & Initial work