Autogenerate openapi

.github/workflows/svelte-kit.yml

@@ -7,17 +7,37 @@ on:
     branches: [master]
     paths:
       - frontend/svelte-kit/**
+      - backend/spring-boot/src/main/java/**
   pull_request:
     branches: [master]
     paths:
       - frontend/svelte-kit/**
+      - backend/spring-boot/src/main/java/**
 
 env:
   PUBLIC_APP_NAME: ${{vars.PUBLIC_APP_NAME}}
   PUBLIC_API_URL: ${{vars.PUBLIC_API_URL}}
 
 jobs:
+  changes:
+    runs-on: ubuntu-latest
+    outputs:
+      frontend: ${{ steps.filter.outputs.frontend }}
+      backend: ${{ steps.filter.outputs.backend }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          filters: |
+            frontend:
+              - 'frontend/svelte-kit/**'
+            backend:
+              - 'backend/spring-boot/src/main/java/**'
+
   build:
+    needs: changes
+    if: needs.changes.outputs.frontend == 'true' || github.event_name == 'workflow_dispatch'
     defaults:
       run:
         working-directory: frontend/svelte-kit
@@ -52,6 +72,87 @@ jobs:
           npx playwright install --with-deps
           npx playwright test --pass-with-no-tests
 
+  check-models:
+    needs: changes
+    if: needs.changes.outputs.backend == 'true' || github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-latest
+
+    env:
+      REDIS_PASSWORD: ""
+
+    services:
+      postgres:
+        image: postgres:17
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: root
+          POSTGRES_DB: bugzkit
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+      redis:
+        image: redis:7
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: "21"
+          distribution: "temurin"
+          cache: maven
+
+      - name: Build Spring Boot
+        run: mvn -B clean install -DskipTests
+        working-directory: backend/spring-boot
+
+      - name: Start Spring Boot
+        run: mvn spring-boot:run -Dspring-boot.run.profiles=dev &
+        working-directory: backend/spring-boot
+
+      - name: Wait for backend
+        run: |
+          for i in {1..30}; do
+            curl -sf http://localhost:8080/v3/api-docs > /dev/null && echo "Backend ready" && exit 0
+            echo "Waiting... ($i/30)"
+            sleep 5
+          done
+          echo "Backend failed to start" && exit 1
+
+      - name: Set up Node.js 22
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - name: Install frontend dependencies
+        run: pnpm i
+        working-directory: frontend/svelte-kit
+
+      - name: Generate models
+        run: pnpm run generate:models
+        working-directory: frontend/svelte-kit
+
+      - name: Check for model drift
+        run: git diff --exit-code frontend/svelte-kit/src/lib/models/api.d.ts
+
   push-image:
     needs: build
     runs-on: ubuntu-latest

backend/spring-boot/src/main/java/org/bugzkit/api/admin/controller/UserController.java

@@ -1,5 +1,7 @@
 package org.bugzkit.api.admin.controller;
 
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import org.bugzkit.api.admin.payload.request.PatchUserRequest;
 import org.bugzkit.api.admin.payload.request.UserRequest;
@@ -14,6 +16,8 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+@Tag(name = "admin")
+@SecurityRequirement(name = "cookieAuth")
 @RestController("adminUserController")
 @RequestMapping(Path.ADMIN_USERS)
 public class UserController extends CrudController<UserDTO, UserRequest> {

backend/spring-boot/src/main/java/org/bugzkit/api/auth/controller/AuthController.java

@@ -1,5 +1,7 @@
 package org.bugzkit.api.auth.controller;
 
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.servlet.http.HttpServletRequest;
 import jakarta.validation.Valid;
 import java.util.List;
@@ -30,6 +32,7 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+@Tag(name = "auth")
 @RestController
 @RequestMapping(Path.AUTH)
 public class AuthController {
@@ -74,6 +77,7 @@ public ResponseEntity<Void> deleteTokens(HttpServletRequest request) {
     return removeAuthCookies();
   }
 
+  @SecurityRequirement(name = "cookieAuth")
   @GetMapping("/tokens/devices")
   public ResponseEntity<List<DeviceDTO>> findAllDevices(HttpServletRequest request) {
     final var accessToken = AuthUtil.getValueFromCookie("accessToken", request);
@@ -87,6 +91,7 @@ public ResponseEntity<Void> deleteTokensOnAllDevices() {
     return removeAuthCookies();
   }
 
+  @SecurityRequirement(name = "cookieAuth")
   @DeleteMapping("/tokens/devices/{deviceId}")
   public ResponseEntity<Void> revokeDevice(@PathVariable String deviceId) {
     deviceService.revoke(deviceId);

backend/spring-boot/src/main/java/org/bugzkit/api/shared/config/SpringDocConfig.java

@@ -0,0 +1,50 @@
+package org.bugzkit.api.shared.config;
+
+import io.swagger.v3.core.converter.AnnotatedType;
+import io.swagger.v3.core.converter.ModelConverters;
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Contact;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.info.License;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+import org.bugzkit.api.shared.error.ErrorMessage;
+import org.springdoc.core.customizers.OpenApiCustomizer;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class SpringDocConfig {
+
+  @Bean
+  public OpenAPI openAPI() {
+    return new OpenAPI()
+        .info(
+            new Info()
+                .title("bugzkit")
+                .description("A production-ready web application template")
+                .version("1.0.0")
+                .contact(new Contact().email("office@bugzkit.com"))
+                .license(
+                    new License()
+                        .name("MIT License")
+                        .url("https://choosealicense.com/licenses/mit/")))
+        .components(
+            new Components()
+                .addSecuritySchemes(
+                    "cookieAuth",
+                    new SecurityScheme()
+                        .type(SecurityScheme.Type.APIKEY)
+                        .in(SecurityScheme.In.COOKIE)
+                        .name("accessToken")));
+  }
+
+  @Bean
+  public OpenApiCustomizer errorMessageSchema() {
+    return openApi ->
+        openApi
+            .getComponents()
+            .getSchemas()
+            .putAll(ModelConverters.getInstance().readAll(new AnnotatedType(ErrorMessage.class)));
+  }
+}

backend/spring-boot/src/main/java/org/bugzkit/api/user/controller/ProfileController.java

@@ -1,5 +1,7 @@
 package org.bugzkit.api.user.controller;
 
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import org.bugzkit.api.shared.constants.Path;
 import org.bugzkit.api.shared.ratelimit.RateLimit;
@@ -15,6 +17,8 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+@Tag(name = "profile")
+@SecurityRequirement(name = "cookieAuth")
 @RestController
 @RequestMapping(Path.PROFILE)
 public class ProfileController {

backend/spring-boot/src/main/java/org/bugzkit/api/user/controller/RoleController.java

@@ -1,5 +1,7 @@
 package org.bugzkit.api.user.controller;
 
+import io.swagger.v3.oas.annotations.security.SecurityRequirement;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.List;
 import org.bugzkit.api.shared.constants.Path;
 import org.bugzkit.api.user.payload.dto.RoleDTO;
@@ -9,6 +11,8 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+@Tag(name = "roles")
+@SecurityRequirement(name = "cookieAuth")
 @RestController
 @RequestMapping(Path.ROLES)
 public class RoleController {

backend/spring-boot/src/main/java/org/bugzkit/api/user/controller/UserController.java

@@ -1,5 +1,6 @@
 package org.bugzkit.api.user.controller;
 
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import org.bugzkit.api.shared.constants.Path;
 import org.bugzkit.api.shared.payload.dto.AvailabilityDTO;
@@ -18,6 +19,7 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+@Tag(name = "users")
 @RestController
 @RequestMapping(Path.USERS)
 public class UserController {

backend/spring-boot/src/main/resources/application.yml

@@ -52,7 +52,3 @@ jwt:
 
 rate-limit:
   enabled: true
-
-springdoc:
-  swagger-ui:
-    url: /openapi.yml