Add swagger customizer to be behind reverse proxy

Author: gavlyukovskiy

README.md

@@ -43,7 +43,7 @@ Without authentication, you can only access the public endpoints, for example:
 curl http://localhost:8080/courses
 ```
 
-You can also see all available endpoints in the [OpenAPI documentation](http://localhost:8080/swagger/swagger-ui/index.html).
+You can also see all available endpoints in the [OpenAPI documentation](http://localhost:8080/swagger-ui/index.html).
 
 ### Running the frontend
 

src/main/java/net/hackyourfuture/coursehub/SecurityConfig.java

@@ -39,7 +39,7 @@ public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
                         .permitAll()
                         .requestMatchers(HttpMethod.POST, "/login", "/register")
                         .permitAll()
-                        .requestMatchers(HttpMethod.GET, "/courses", "/swagger/**")
+                        .requestMatchers(HttpMethod.GET, "/courses", "/swagger-ui/**", "/v3/api-docs/**")
                         .permitAll()
                         .requestMatchers("/students/**")
                         .hasRole("student")

src/main/java/net/hackyourfuture/coursehub/SwaggerBehindReverseProxyConfig.java

@@ -0,0 +1,19 @@
+package net.hackyourfuture.coursehub;
+
+import org.springdoc.core.customizers.ServerBaseUrlCustomizer;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class SwaggerBehindReverseProxyConfig {
+
+    @Bean
+    ServerBaseUrlCustomizer serverBaseUrlCustomizer() {
+        return (serverBaseUrl, request) -> {
+            if (serverBaseUrl.contains("coursehub.hyf.dev")) {
+                return serverBaseUrl + "/api";
+            }
+            return serverBaseUrl;
+        };
+    }
+}

src/main/java/net/hackyourfuture/coursehub/web/StudentController.java

@@ -5,15 +5,12 @@
 import net.hackyourfuture.coursehub.service.CourseService;
 import net.hackyourfuture.coursehub.web.model.CourseListResponse;
 import org.springframework.http.HttpStatus;
-import org.springframework.http.HttpStatusCode;
 import org.springframework.security.core.annotation.AuthenticationPrincipal;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
-import org.springframework.web.client.HttpClientErrorException;
-import org.springframework.web.client.HttpServerErrorException;
-import org.springframework.web.client.HttpStatusCodeException;
+import org.springframework.web.server.ResponseStatusException;
 
 @RestController
 @RequestMapping("/students")
@@ -29,7 +26,7 @@ public StudentController(CourseService courseService) {
     public CourseListResponse getCoursesForStudent(
             @PathVariable @Positive Integer studentId, @AuthenticationPrincipal AuthenticatedUser user) {
         if (!user.getUserId().equals(studentId)) {
-            throw new HttpClientErrorException(HttpStatus.FORBIDDEN);
+            throw new ResponseStatusException(HttpStatus.FORBIDDEN);
         }
         var courses = courseService.getCoursesForStudent(studentId);
         return new CourseListResponse(courses);

src/main/resources/application.properties

@@ -8,6 +8,3 @@ spring.datasource.password=course_user_password
 
 # Server configuration
 server.port=8080
-
-springdoc.swagger-ui.path=/swagger/swagger-ui.html
-springdoc.api-docs.path=/swagger/v3/api-docs