Merge pull request #62 from mbc-net/feat/generate_swagger

[CLI]: the template supports generating API documentation
mbc-net · Nov 20, 2024 · bd26145 · bd26145
2 parents 3acb7fb + c523454
commit bd26145
Show file tree

Hide file tree

Showing 3 changed files with 88 additions and 1 deletion.
diff --git a/packages/cli/templates/infra/libs/pipeline-stack.ts b/packages/cli/templates/infra/libs/pipeline-stack.ts
@@ -57,6 +57,7 @@ export class PipelineStack extends Stack {
         'npm run test', // source test
         'npm --prefix ./infra run test', // infra snapshot test
         'npm --prefix ./infra run cdk synth', // generate infra diagram
+        'npm ci && cp .env.local .env && npm run generate:swagger', // generate api doc
       ],
       primaryOutputDirectory: 'report',
       partialBuildSpec: BuildSpec.fromObject({

diff --git a/packages/cli/templates/package.json b/packages/cli/templates/package.json
@@ -36,7 +36,8 @@
     "migrate:dev": "prisma migrate dev",
     "migrate:rds": "prisma migrate deploy",
     "migrate:ddb": "ts-node prisma/ddb.ts",
-    "migrate": "npm run migrate:rds && npm run migrate:ddb"
+    "migrate": "npm run migrate:rds && npm run migrate:ddb",
+    "generate:swagger": "nest start --entryFile generate-swagger"
   },
   "dependencies": {
     "@mbc-cqrs-serverless/core": "",

diff --git a/packages/cli/templates/src/generate-swagger.ts b/packages/cli/templates/src/generate-swagger.ts
@@ -0,0 +1,85 @@
+/* eslint-disable no-console */
+import { AppModule, HEADER_TENANT_CODE } from '@mbc-cqrs-serverless/core'
+import { NestFactory } from '@nestjs/core'
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger'
+import { existsSync, mkdirSync, writeFileSync } from 'fs'
+import path from 'path'
+import { format } from 'prettier'
+
+import { MainModule } from './main.module'
+
+const template = `<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <meta
+    name="description"
+    content="serverless"
+  />
+  <title>serverless</title>
+  <link rel="stylesheet" href="https://unpkg.com/[email protected]/swagger-ui.css" />
+</head>
+<body>
+  <div id="swagger-ui"></div>
+  <script src="https://unpkg.com/[email protected]/swagger-ui-bundle.js" crossorigin></script>
+  <script src="https://unpkg.com/[email protected]/swagger-ui-standalone-preset.js" crossorigin></script>
+  <script>
+    window.onload = () => {
+      window.ui = SwaggerUIBundle({
+        spec: ###JSON###,
+        dom_id: '#swagger-ui',
+      });
+    };
+  </script>
+</body>
+</html>`
+
+async function generateSwagger() {
+  const app = await NestFactory.create(
+    AppModule.forRoot({
+      rootModule: MainModule,
+    }),
+  )
+  const config = new DocumentBuilder()
+    .setTitle('serverless')
+    .setDescription('The serverless API')
+    .addApiKey(
+      { type: 'apiKey', name: 'Authorization', in: 'header' },
+      'Api-Key',
+    )
+    .addSecurityRequirements('Api-Key')
+    .addGlobalParameters({
+      in: 'header',
+      required: false,
+      name: HEADER_TENANT_CODE,
+    })
+    .build()
+
+  const document = SwaggerModule.createDocument(app, config, {
+    deepScanRoutes: true,
+  })
+
+  const reportDir = path.join(__dirname, '../report')
+
+  if (!existsSync(reportDir)) {
+    mkdirSync(reportDir)
+  }
+
+  format(JSON.stringify(document), {
+    parser: 'json',
+  }).then((ret) => writeFileSync(path.join(reportDir, 'swagger.json'), ret))
+
+  writeFileSync(
+    path.join(reportDir, 'swagger-ui.html'),
+    template.replace('###JSON###', JSON.stringify(document)),
+  )
+
+  console.log('Swagger documentation has been successfully generated!')
+  await app.close()
+}
+
+generateSwagger().catch((err) => {
+  console.error('Error generating Swagger documentation:', err)
+  process.exit(1)
+})