RealWorld spec and API.
Spring boot + MyBatis codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the
This codebase was created to demonstrate a fully fledged full-stack application built with Spring boot + Mybatis including CRUD operations, authentication, routing, pagination, and more.
For more information on how to this works with other frontends/backends, head over to the RealWorld repo.
NEW GraphQL Support
Following some DDD principles. REST or GraphQL is just a kind of adapter. And the domain layer will be consistent all the time. So this repository implement GraphQL and REST at the same time.
The GraphQL schema is https://github.com/gothinkster/spring-boot-realworld-example-app/blob/master/src/main/resources/schema/schema.graphqls and the visualization looks like below.
And this implementation is using dgs-framework which is a quite new java graphql server framework.
How it works
The application uses Spring Boot (Web, Mybatis).
- Use the idea of Domain Driven Design to separate the business term and infrastructure term.
- Use MyBatis to implement the Data Mapper pattern for persistence.
- Use CQRS pattern to separate the read model and write model.
And the code is organized as this:
api
is the web layer implemented by Spring MVCcore
is the business model including entities and servicesapplication
is the high-level services for querying the data transfer objectsinfrastructure
contains all the implementation classes as the technique details
Security
Integration with Spring Security and add other filter for jwt token process.
The secret key is stored in application.properties
.
Database
It uses a H2 in-memory database sqlite database (for easy local test without losing test data after every restart), can be changed easily in the application.properties
for any other database.
Getting started
You'll need Java 11 installed.
./gradlew bootRun
To test that it works, open a browser tab at http://localhost:8080/tags .
Alternatively, you can run
curl http://localhost:8080/tags
Docker
Try it out withYou'll need Docker installed.
./gradlew bootBuildImage --imageName spring-boot-realworld-example-app
docker run -p 8081:8080 spring-boot-realworld-example-app
Try it out with a RealWorld frontend
The entry point address of the backend API is at http://localhost:8080, not http://localhost:8080/api as some of the frontend documentation suggests.
Run test
The repository contains a lot of test cases to cover both api test and repository test.
./gradlew test
Code format
Use spotless for code format.
./gradlew spotlessJavaApply
Help
Please fork and PR to improve the project.