How fiskra/sample-web-service works
Project type and purpose
• This is a SIMPLE WEB SERVICE PROJECT built with Spring Boot. It exposes RESTful endpoints for “User” and “Bookmark” resources via HTTP.
• It uses Java 8, Maven, Spring-Boot (web, JPA, security), Jersey, H2 in-memory DB, and an Angular.js front end (mentioned in README).
File structure
• Top-level files:
• pom.xml (Maven build configuration)
• LICENSE, readMe.md
• src/main/java/com/fiskra/ws
• SampleWsApplication.java – the Spring-Boot entry point
• ServletInitializer.java – for servlet container bootstrapping
• controller/BookmarkController.java & UserController.java – REST endpoints (presentation layer)
• model/Bookmark, BookmarkResource, User – JPA entities & HATEOAS resource wrappers
• repo/BookmarkRepository, UserRepository – Spring Data JPA repositories (data access layer)
• src/main/resources/application.properties – runtime configuration
• src/main/resources/import.sql – initial data load into H2
• src/test – integration/unit tests
Key architecture patterns & design principles
• Layered (tiered) architecture:
• Presentation layer (REST controllers)
• Business/domain model (entities & resource assemblers)
• Data access layer (Spring Data repositories)
• Persistence (H2 in-memory DB)
• Follows MVC-like separation for a REST API.
• Dependency Injection via Spring.
• Uses JPA for ORM; H2 for ephemeral development DB.
• REST HATEOAS principles (BookmarkResource) for enriched hypermedia responses.
Main components
a. External Clients
• Angular.js front-end (or any HTTP client / REST client)
• Curl/Postman for testing
b. Spring-Boot Application
• Embedded servlet container (Tomcat/Jetty)
• ServletInitializer
• SampleWsApplication (main)
c. REST Controllers
• UserController
• BookmarkController
d. Service/Resource Assemblers (optionally show BookmarkResource)
e. Data Access Layer
• UserRepository
• BookmarkRepository
f. Persistence
• H2 in-memory database
• import.sql pre-loading
g. Tests
• SampleWsApplicationTests (integration test)
Relationships & data flow
1) Client → HTTP request → Embedded Servlet Container
2) Container → SampleWsApplication context
3) Controller (UserController / BookmarkController) mapped via Jersey/Spring MVC
4) Controller calls Repository (UserRepository / BookmarkRepository)
5) Repository ↔ JPA ↔ H2 Database
6) Controller assembles response (possibly via BookmarkResource) and returns JSON/XML to client