Pet-Shop REST API

This project exposes some REST CRUD service for a Pet Shop. It demonstrates the use of Spring-boot & Java 8. An h2 in memory database has been used to store the pet shop data. These services are consumed by a front-end app hosted on another Github project : pet-shop-reactjs.

Important : The project requires maven 3.x and a Java 8 jdk.

1. Installation

Clone the github repository :

git clone https://github.com/perscrew/pet-rest-api.git

Launch mvn clean install to build the project

mvn clean install

By default mvn clean install runs also the test units included in the project. In the case of some unit test failed, you can run the following command :

mvn clean install -DskipTests

2. Set up server port and database configuration

The configuration file application.properties allows you to change default parameters.

You can set-up the server port :

server.port=8080

You can set-up the database configuration :

#datasource
spring.datasource.url=jdbc:h2:mem:mydb;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
spring.h2.console.path=/myconsole
spring.h2.console.enabled=true
spring.datasource.initialize=true
spring.datasource.schema=classpath:schema.sql
spring.datasource.data=classpath:import.sql

If you would like to use another database please don't forget to add the driver dependency in the pom.xml.

Ex :

<dependency>
 <groupId>com.oracle.jdbc</groupId>
 <artifactId>ojdbc7</artifactId>
 <version>12.1.0.2</version>
</dependency>

3. Launch the REST server

Run mvn spring-boot:run in the pet-rest-api-web module to launch spring-boot server (a Tomcat is bundled by default)

cd pet-rest-api-web
mvn spring-boot:run

Spring boot generates a single jar that includes everything. You could also run the app like this :

java -jar pet-rest-api-web/target/pet-rest-api-web-0.0.1-SNAPSHOT.jar

4. REST services documentation (Swagger)

The Rest services are documented with the Swagger api documentation available on these URL, once you run the server : http://localhost:8080/swagger-ui.html

You can also test directly the service with the swagger ui :

5. Run test units

To run only the test units run mvn test :

mvn test

6. Appendices

###Third party libraries used

You will find below the different third party libraries used in the project.

Dependency	Benefits
`spring-boot`	Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications that you can "just run"
`swagger`	Swagger is a powerful open source framework backed by a large ecosystem of tools that helps you design, build, document, and consume your RESTful APIs.
`h2database`	Very fast, open source, JDBC API. Embedded and server modes; in-memory databases.

Potential enhancements

Use Spring profile to allow multiple environments configuration.
Add OAUTH2 or JWT security to retrieve a token for the frontend. The library spring-security could be used.
Use Jpa transactions to handle concurrency
Add a service layer to wrap dao call. Currently the dao are called from the rest controller.

perscrew / pet-rest-api