How spring-petclinic/spring-petclinic-graphql works
Project type and purpose
• This is a full-stack sample application (“PetClinic”) demonstrating a GraphQL API built with Spring Boot/Spring for GraphQL (backend module), a React/Apollo single-page app frontend (frontend module), and a customized GraphiQL client (petclinic-graphiql module). It also includes end-to-end tests (e2e-tests) and Docker/Docker-Compose configurations for local and production-like deployments.
File structure
• Top-level modules:
• backend – Spring Boot GraphQL service (Java/Maven)
• frontend – React + Apollo GraphQL client (TypeScript/pnpm/Vite)
• petclinic-graphiql – standalone GraphiQL UI with login (TypeScript/pnpm/Vite)
• e2e-tests – Playwright tests against running containers
• docker-compose*.yml, build scripts, GitHub workflows
• backend uses layered packages: graphql controllers, model, repository, security, util, runtime wiring.
• Configuration files: application.properties, GraphQL schema, Flyway migrations, JWT key pair.
• Frontend uses GraphQL codegen, Apollo client setup, login flow, GraphQL queries & subscriptions.
• Deployment: Dockerfiles for frontend and backend, nginx proxy in docker-compose-petclinic.yml.
README for additional insights
• GraphQL API endpoints (HTTP /graphql and WebSocket /graphqlws) secured by JWT.
• Features: annotated controllers, custom scalars, paging/filtering, subscriptions, @PreAuthorize methods, testcontainers integration.
• Development vs “production” setup: local dev uses Vite dev server with proxy, production uses nginx reverse proxy.
a. Main components
• PostgreSQL database (Flyway migrations)
• Spring Boot GraphQL server
– GraphQL HTTP endpoint
– GraphQL WebSocket endpoint
– Security: JWT issuance & validation
– Service layer (PetService, OwnerService, VetService, VisitService)
– Repository layer (Spring Data JPA)
– GraphQL controllers/resolvers (AuthController, OwnerController, VisitController, etc.)
• React SPA frontend (frontend)
– Apollo Client (queries, mutations, subscriptions)
– UI components, login flow (AuthTokenProvider)
• Custom GraphiQL client (petclinic-graphiql)
• Reverse proxy / CDN (nginx in production)
• CI/CD & container orchestration
– GitHub Actions building images, running tests
– Docker-Compose for multi-container setup
• E2E test runner (Playwright)
b. Relationships & interactions
• SPA & GraphiQL → HTTP POST /graphql (queries, mutations)
• SPA → WebSocket /graphqlws (subscriptions)
• GraphQL server → database via JPA repositories
• Client login → /login endpoint → JWT token → stored in browser → attached to GraphQL calls
• nginx (prod) or Vite proxy (dev) → routes /graphql, /api to backend
• CI pipeline triggers build → spin up containers → run e2e tests
c. Architectural patterns & principles
• Layered architecture: controllers → services → repositories
• GraphQL schema-first with runtime wiring (scalars, interfaces, unions)
• Event-driven subscriptions (VisitPublisher)
• Security by design: JWT, method-level @PreAuthorize checks
• Paging/Filtering via Relay cursor connections
• Dev/prod parity with Docker Compose
d. Key technologies & frameworks
• Java 17, Spring Boot 3.x, Spring for GraphQL
• Flyway for DB migrations
• PostgreSQL
• React, TypeScript, Apollo Client, Vite
• GraphiQL (custom build)
• Playwright for E2E
• Docker, Docker Compose, nginx
• GitHub Actions
Detail
• Subscription path (VisitController → VisitPublisher → WS).
• JWT login flow (LoginController → JwtTokenService → key store).