The goal of this project is to provide a template for an enterprise level Java REST service or web project. It provides a more complete sample than most trivial sample apps and aims to provide a solid foundation for building, testing, deploying, extending, and modularizing. The goal is to provide piecemeal loosely coupled web components to help build web services and applications while trying not to lock the developers into any specific vendors. The project tries to use JSR specifications where possible and give developers flexibility in adding or removing most components. The JAVA JAX-RS Bootstrap uses the following technologies.
- Maven for the build system.
- JUnit for unit testing.
- JAX-RS for rest services using the Jersey reference implementation.
- CDI with Weld for dependency injection.
- JPA for relational database interaction.
- Spring Data JPA for simplfying the DAO persistence layer.
- SLF4J for logging.
- Shiro for security
- Scalate for web templates.
$mvn clean package
Windows:
$ run.bat
Linux: $ run.sh
Browse localhost:8080
We use a modular project design to split the project into multiple jars. Model and persistence code goes into the model layer jar. Services, validation, buisiness logic, and UI go into the webapp jar.
To add a new model and service to the project:
-
Create a JPA @Entity ModelName in com.bootstrap.models to define database schema.
-
Create a entity persistence interface that extends BasePersistence<ModelName>. Spring-data will automatically create an implementation of this interface. You can get spring-data to generate more CRUD methods by defining additional @Queries on you JPA model classes. See spring-data docs for more information.
-
Create a Jax-rs service class that exposes models through REST interface. Add additional business logic here. Use @Inject on class variable of persistence class and spring will automatically inject an implementation of the persistence class on startup.