The gothinkster/spring-boot-realworld-example-app is a Spring Boot implementation of the RealWorld backend API spec. It serves as a demonstration of how to build a real-world application using Spring Boot, following best practices and modern development techniques. This project is part of the larger RealWorld initiative, which aims to create exemplary fullstack applications across various tech stacks.

Pros

• Implements a comprehensive, real-world API specification
• Uses Spring Boot, a popular and well-supported framework for Java applications
• Follows best practices and modern development techniques
• Serves as an excellent learning resource for developers

Cons

• May be complex for beginners to understand all aspects of the implementation
• Requires knowledge of Java and Spring Boot ecosystem
• Limited documentation on project-specific implementation details
• May require updates to keep up with evolving Spring Boot versions and best practices

Code Examples

Here are a few code examples from the project:

1. User registration endpoint:

@PostMapping("/users")
public ResponseEntity createUser(@Valid @RequestBody RegisterParam registerParam) {
    User user = userService.createUser(registerParam);
    UserWithToken userWithToken = userService.userWithToken(user);
    return ResponseEntity.status(201).body(userWithToken);
}

This code defines a POST endpoint for user registration, validating the input and returning the created user with a token.

2. Article creation:

@PostMapping("/articles")
public ResponseEntity createArticle(@Valid @RequestBody NewArticleParam newArticleParam,
                                    @AuthenticationPrincipal User currentUser) {
    Article article = articleService.createArticle(newArticleParam, currentUser);
    return ResponseEntity.status(201).body(articleResponse(article));
}

This code handles the creation of a new article, using the authenticated user as the author.

3. JWT authentication filter:

@Component
public class JwtTokenFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
            throws ServletException, IOException {
        String token = jwtTokenProvider.resolveToken(request);
        if (token != null && jwtTokenProvider.validateToken(token)) {
            Authentication auth = jwtTokenProvider.getAuthentication(token);
            SecurityContextHolder.getContext().setAuthentication(auth);
        }
        filterChain.doFilter(request, response);
    }
}

This code implements a JWT token filter for authentication, validating the token and setting the authentication context.

Getting Started

To get started with this project:

1. Clone the repository:

   git clone https://github.com/gothinkster/spring-boot-realworld-example-app.git
   

2. Navigate to the project directory:

   cd spring-boot-realworld-example-app
   

3. Build and run the application:

   ./gradlew bootRun
   

4. The API will be available at http://localhost:8080/api

For more detailed instructions and API documentation, refer to the project's README file.