feat: Publish OpenApi schema as build artifact

.github/workflows/ci.yml

@@ -13,3 +13,12 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - run: npm ci 2>/dev/null || npm install
       - run: npm test 2>/dev/null || echo "Tests completed"
+      - name: Generate OpenAPI
+        run: |
+          cd backend
+          npm run generate-openapi
+      - name: Upload OpenAPI artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: openapi-schema
+          path: backend/openapi.json

backend/package.json

@@ -18,7 +18,8 @@
     "test:watch": "jest --watch",
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
-    "test:e2e": "jest --config ./test/jest-e2e.json"
+    "test:e2e": "jest --config ./test/jest-e2e.json",
+    "generate-openapi": "ts-node -T -r tsconfig-paths/register src/scripts/generate-openapi.ts"
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.975.0",
@@ -88,6 +89,7 @@
     "@types/qrcode": "^1.5.6",
     "@types/supertest": "^6.0.2",
     "@types/uuid": "^10.0.0",
+    "cross-env": "^10.1.0",
     "eslint": "^9.18.0",
     "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-prettier": "^5.2.2",

backend/src/scripts/generate-openapi.ts

@@ -0,0 +1,37 @@
+import { NestFactory } from '@nestjs/core';
+import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
+import { AppModule } from '../app.module';
+import * as fs from 'fs';
+import * as path from 'path';
+
+async function generateOpenApi() {
+  console.log('Starting OpenAPI generation...');
+
+  const app = await NestFactory.create(AppModule, { logger: false });
+
+  const config = new DocumentBuilder()
+    .setTitle('StellarCert API')
+    .setDescription('Certificate Management System API Documentation')
+    .setVersion('1.0')
+    .addBearerAuth(
+      { type: 'http', scheme: 'bearer', bearerFormat: 'JWT' },
+      'access-token',
+    )
+    .build();
+
+  const document = SwaggerModule.createDocument(app, config);
+
+  fs.writeFileSync(
+    path.join(__dirname, '../../../openapi.json'),
+    JSON.stringify(document, null, 2),
+  );
+  console.log('Document written to openapi.json');
+
+  await app.close();
+  console.log('Generation completed.');
+}
+
+generateOpenApi().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});