## Pet Attributes API Persistent Assignment ## Project Updates - **Refactored / Rearranged Project Structure** [Commit Link](https://github.com/shrirangjoshi94/spring-petclinic/commit/569cc89c3ae4ebe50a432022cbf71e568ef5b4d5) - **Save and Fetch Pet Attributes Feature** [Pull Request Link](https://github.com/shrirangjoshi94/spring-petclinic/pull/2) --- ### Development Notes What I did was first restructured the project and merged the refactoring PR. Then I created a new PR to implement the save and fetch Pet Attributes feature. ### 1. Save Attributes for a Pet **POST** `/pets/{petId}/attributes` Example request: `POST localhost:8080/pets/2/attributes` **Request Body:** ```json { "temperament": "angry", "lengthCm": 401, "weightKg": 100 } ``` ### 2. GET Attributes for a Pet **GET** `/pets/{petId}/attributes` Example request: `GET localhost:8080/pets/2/attributes` ---------------------------------------------------------- # Spring PetClinic Sample Application [![Build Status](https://github.com/spring-projects/spring-petclinic/actions/workflows/maven-build.yml/badge.svg)](https://github.com/spring-projects/spring-petclinic/actions/workflows/maven-build.yml)[![Build Status](https://github.com/spring-projects/spring-petclinic/actions/workflows/gradle-build.yml/badge.svg)](https://github.com/spring-projects/spring-petclinic/actions/workflows/gradle-build.yml) [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/spring-projects/spring-petclinic) [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=7517918) ## Understanding the Spring Petclinic application with a few diagrams [See the presentation here](https://speakerdeck.com/michaelisvy/spring-petclinic-sample-application) ## Run Petclinic locally Spring Petclinic is a [Spring Boot](https://spring.io/guides/gs/spring-boot) application built using [Maven](https://spring.io/guides/gs/maven/) or [Gradle](https://spring.io/guides/gs/gradle/). You can build a jar file and run it from the command line (it should work just as well with Java 17 or newer): ```bash git clone https://github.com/spring-projects/spring-petclinic.git cd spring-petclinic ./mvnw package java -jar target/*.jar ``` (On Windows, or if your shell doesn't expand the glob, you might need to specify the JAR file name explicitly on the command line at the end there.) You can then access the Petclinic at . petclinic-screenshot Or you can run it from Maven directly using the Spring Boot Maven plugin. If you do this, it will pick up changes that you make in the project immediately (changes to Java source files require a compile as well - most people use an IDE for this): ```bash ./mvnw spring-boot:run ``` > NOTE: If you prefer to use Gradle, you can build the app using `./gradlew build` and look for the jar file in `build/libs`. ## Building a Container There is no `Dockerfile` in this project. You can build a container image (if you have a docker daemon) using the Spring Boot build plugin: ```bash ./mvnw spring-boot:build-image ``` ## In case you find a bug/suggested improvement for Spring Petclinic Our issue tracker is available [here](https://github.com/spring-projects/spring-petclinic/issues). ## Database configuration In its default configuration, Petclinic uses an in-memory database (H2) which gets populated at startup with data. The h2 console is exposed at `http://localhost:8080/h2-console`, and it is possible to inspect the content of the database using the `jdbc:h2:mem:` URL. The UUID is printed at startup to the console. A similar setup is provided for MySQL and PostgreSQL if a persistent database configuration is needed. Note that whenever the database type changes, the app needs to run with a different profile: `spring.profiles.active=mysql` for MySQL or `spring.profiles.active=postgres` for PostgreSQL. See the [Spring Boot documentation](https://docs.spring.io/spring-boot/how-to/properties-and-configuration.html#howto.properties-and-configuration.set-active-spring-profiles) for more detail on how to set the active profile. You can start MySQL or PostgreSQL locally with whatever installer works for your OS or use docker: ```bash docker run -e MYSQL_USER=petclinic -e MYSQL_PASSWORD=petclinic -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:9.1 ``` or ```bash docker run -e POSTGRES_USER=petclinic -e POSTGRES_PASSWORD=petclinic -e POSTGRES_DB=petclinic -p 5432:5432 postgres:17.0 ``` Further documentation is provided for [MySQL](https://github.com/spring-projects/spring-petclinic/blob/main/src/main/resources/db/mysql/petclinic_db_setup_mysql.txt) and [PostgreSQL](https://github.com/spring-projects/spring-petclinic/blob/main/src/main/resources/db/postgres/petclinic_db_setup_postgres.txt). Instead of vanilla `docker` you can also use the provided `docker-compose.yml` file to start the database containers. Each one has a service named after the Spring profile: ```bash docker compose up mysql ``` or ```bash docker compose up postgres ``` ## Test Applications At development time we recommend you use the test applications set up as `main()` methods in `PetClinicIntegrationTests` (using the default H2 database and also adding Spring Boot Devtools), `MySqlTestApplication` and `PostgresIntegrationTests`. These are set up so that you can run the apps in your IDE to get fast feedback and also run the same classes as integration tests against the respective database. The MySql integration tests use Testcontainers to start the database in a Docker container, and the Postgres tests use Docker Compose to do the same thing. ## Compiling the CSS There is a `petclinic.css` in `src/main/resources/static/resources/css`. It was generated from the `petclinic.scss` source, combined with the [Bootstrap](https://getbootstrap.com/) library. If you make changes to the `scss`, or upgrade Bootstrap, you will need to re-compile the CSS resources using the Maven profile "css", i.e. `./mvnw package -P css`. There is no build profile for Gradle to compile the CSS. ## Working with Petclinic in your IDE ### Prerequisites The following items should be installed in your system: - Java 17 or newer (full JDK, not a JRE) - [Git command line tool](https://help.github.com/articles/set-up-git) - Your preferred IDE - Eclipse with the m2e plugin. Note: when m2e is available, there is an m2 icon in `Help -> About` dialog. If m2e is not there, follow the install process [here](https://www.eclipse.org/m2e/) - [Spring Tools Suite](https://spring.io/tools) (STS) - [IntelliJ IDEA](https://www.jetbrains.com/idea/) - [VS Code](https://code.visualstudio.com) ### Steps 1. On the command line run: ```bash git clone https://github.com/spring-projects/spring-petclinic.git ``` 1. Inside Eclipse or STS: Open the project via `File -> Import -> Maven -> Existing Maven project`, then select the root directory of the cloned repo. Then either build on the command line `./mvnw generate-resources` or use the Eclipse launcher (right-click on project and `Run As -> Maven install`) to generate the CSS. Run the application's main method by right-clicking on it and choosing `Run As -> Java Application`. 1. Inside IntelliJ IDEA: In the main menu, choose `File -> Open` and select the Petclinic [pom.xml](pom.xml). Click on the `Open` button. - CSS files are generated from the Maven build. You can build them on the command line `./mvnw generate-resources` or right-click on the `spring-petclinic` project then `Maven -> Generates sources and Update Folders`. - A run configuration named `PetClinicApplication` should have been created for you if you're using a recent Ultimate version. Otherwise, run the application by right-clicking on the `PetClinicApplication` main class and choosing `Run 'PetClinicApplication'`. 1. Navigate to the Petclinic Visit [http://localhost:8080](http://localhost:8080) in your browser.