Adding Swagger documentation to the NestJS-mod application and generating a REST client for the Angular application

# Install all need dependencies npm i --save @nestjs/swagger # Install all need dev-dependencies npm i --save-dev prisma-class-generator @openapitools/openapi-generator-cli # Install all need peer-dependencies npm i --save class-transformer class-validator 

# Create Angular library ./node_modules/.bin/nx g @nx/angular:library app-angular-rest-sdk --buildable --publishable --directory=libs/sdk/app-angular-rest-sdk --simpleName=true --projectNameAndRootFormat=as-provided --strict=true --prefix=app-angular-rest-sdk --standalone=true --selector=app-angular-rest-sdk --changeDetection=OnPush --importPath=@nestjs-mod-fullstack/app-angular-rest-sdk # Change file with test options rm -rf libs/sdk/app-angular-rest-sdk/src/test-setup.ts cp apps/client/src/test-setup.ts libs/sdk/app-angular-rest-sdk/src/test-setup.ts 

# Create NestJS library ./node_modules/.bin/nx g @nestjs-mod/schematics:library app-rest-sdk --buildable --publishable --directory=libs/sdk/app-rest-sdk --simpleName=true --projectNameAndRootFormat=as-provided --strict=true 

generator client { provider = "prisma-client-js" output = "../../../../node_modules/@prisma/app-client" engineType = "binary" } generator prismaClassGenerator { provider = "prisma-class-generator" output = "../app/generated/rest/dto" dryRun = "false" separateRelationFields = "false" makeIndexFile = "file" } datasource db { provider = "postgres" url = env("SERVER_APP_DATABASE_URL") } model AppDemo { id String @id(map: "PK_APP_DEMO") @default(dbgenerated("uuid_generate_v4()")) @db.Uuid name String @unique(map: "UQ_APP_DEMO") @db.VarChar(128) createdAt DateTime @default(now()) @db.Timestamp(6) updatedAt DateTime @default(now()) @db.Timestamp(6) } model migrations { installed_rank Int @id(map: "__migrations_pk") version String? @db.VarChar(50) description String @db.VarChar(200) type String @db.VarChar(20) script String @db.VarChar(1000) checksum Int? installed_by String @db.VarChar(100) installed_on DateTime @default(now()) @db.Timestamp(6) execution_time Int success Boolean @@index([success], map: "__migrations_s_idx") @@map("__migrations") } 

import { DefaultNestApplicationInitializer, DefaultNestApplicationListener, InfrastructureMarkdownReportGenerator, PACKAGE_JSON_FILE, ProjectUtils, bootstrapNestApplication, isInfrastructureMode } from '@nestjs-mod/common'; import { DOCKER_COMPOSE_FILE, DockerCompose, DockerComposePostgreSQL } from '@nestjs-mod/docker-compose'; import { FLYWAY_JS_CONFIG_FILE, Flyway } from '@nestjs-mod/flyway'; import { NestjsPinoLoggerModule } from '@nestjs-mod/pino'; import { ECOSYSTEM_CONFIG_FILE, Pm2 } from '@nestjs-mod/pm2'; import { FakePrismaClient, PRISMA_SCHEMA_FILE, PrismaModule } from '@nestjs-mod/prisma'; import { TerminusHealthCheckModule } from '@nestjs-mod/terminus'; import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger'; import { MemoryHealthIndicator } from '@nestjs/terminus'; import { writeFileSync } from 'fs'; import { join, resolve } from 'path'; import { AppModule } from './app/app.module'; const appFeatureName = 'app'; const rootFolder = join(__dirname, '..', '..', '..'); const appFolder = join(rootFolder, 'apps', 'server'); bootstrapNestApplication({ modules: { system: [ ProjectUtils.forRoot({ staticConfiguration: { applicationPackageJsonFile: join(appFolder, PACKAGE_JSON_FILE), packageJsonFile: join(rootFolder, PACKAGE_JSON_FILE), envFile: join(rootFolder, '.env'), }, }), DefaultNestApplicationInitializer.forRoot({ staticConfiguration: { bufferLogs: true }, }), NestjsPinoLoggerModule.forRoot(), TerminusHealthCheckModule.forRootAsync({ configurationFactory: (memoryHealthIndicator: MemoryHealthIndicator) => ({ standardHealthIndicators: [ { name: 'memory_heap', check: () => memoryHealthIndicator.checkHeap('memory_heap', 150 * 1024 * 1024), }, ], }), inject: [MemoryHealthIndicator], }), DefaultNestApplicationListener.forRoot({ staticConfiguration: { // When running in infrastructure mode, the backend server does not start. mode: isInfrastructureMode() ? 'silent' : 'listen', async preListen(options) { if (options.app) { options.app.setGlobalPrefix('api'); const swaggerConf = new DocumentBuilder().addBearerAuth().build(); const document = SwaggerModule.createDocument(options.app, swaggerConf); SwaggerModule.setup('swagger', options.app, document); if (isInfrastructureMode()) { writeFileSync(resolve(__dirname, '..', '..', '..', 'app-swagger.json'), JSON.stringify(document)); } } }, }, }), ], core: [ PrismaModule.forRoot({ staticConfiguration: { schemaFile: join(appFolder, 'src', 'prisma', `${appFeatureName}-${PRISMA_SCHEMA_FILE}`), featureName: appFeatureName, prismaModule: isInfrastructureMode() ? { PrismaClient: FakePrismaClient } : import(`@prisma/app-client`), addMigrationScripts: false, }, }), ], feature: [AppModule.forRoot()], infrastructure: [ InfrastructureMarkdownReportGenerator.forRoot({ staticConfiguration: { markdownFile: join(appFolder, 'INFRASTRUCTURE.MD'), skipEmptySettings: true, }, }), Pm2.forRoot({ configuration: { ecosystemConfigFile: join(rootFolder, ECOSYSTEM_CONFIG_FILE), applicationScriptFile: join('dist/apps/server/main.js'), }, }), DockerCompose.forRoot({ configuration: { dockerComposeFileVersion: '3', dockerComposeFile: join(appFolder, DOCKER_COMPOSE_FILE), }, }), DockerComposePostgreSQL.forRoot(), DockerComposePostgreSQL.forFeature({ featureModuleName: appFeatureName, }), Flyway.forRoot({ staticConfiguration: { featureName: appFeatureName, migrationsFolder: join(appFolder, 'src', 'migrations'), configFile: join(rootFolder, FLYWAY_JS_CONFIG_FILE), }, }), ], }, }); 

{ "generate": { "executor": "nx:run-commands", "options": { "commands": ["./node_modules/.bin/prisma generate --schema=./apps/server/src/prisma/app-schema.prisma", "./node_modules/.bin/rucken make-ts-list", "export NESTJS_MODE=infrastructure && ./node_modules/.bin/nx serve server --host=0.0.0.0 --watch=false", "rm -rf ./libs/sdk/app-angular-rest-sdk/src/lib && mkdir ./libs/sdk/app-angular-rest-sdk/src/lib && ./node_modules/.bin/openapi-generator-cli generate -i ./app-swagger.json -g typescript-angular -o ./libs/sdk/app-angular-rest-sdk/src/lib --additional-properties=apiModulePrefix=RestClient,configurationPrefix=RestClient,fileNaming=kebab-case,modelFileSuffix=.interface,modelSuffix=Interface,enumNameSuffix=Type,enumPropertyNaming=original,serviceFileSuffix=-rest.service,serviceSuffix=RestService", "rm -rf ./libs/sdk/app-rest-sdk/src/lib && mkdir ./libs/sdk/app-rest-sdk/src/lib && ./node_modules/.bin/openapi-generator-cli generate -i ./app-swagger.json -g typescript-axios -o ./libs/sdk/app-rest-sdk/src/lib"], "parallel": false, "envFile": "./.env", "color": true } } } 

sudo apt install default-jre 

node_modules libs/sdk/app-rest-sdk/src/lib libs/sdk/app-angular-rest-sdk/src/lib 

{ "makeTsList": { "indexFileName": "index", "excludes": [ "test-setup.ts", // <-- updates "*node_modules*", "*public_api.ts*", "*.spec*", "environment*", "*e2e*", "*.stories.ts", "*.d.ts" ] } } 

npm run generate 

import { Controller, Delete, Get, Param, Post } from '@nestjs/common'; import { InjectPrismaClient } from '@nestjs-mod/prisma'; import { ApiCreatedResponse, ApiProperty, ApiResponse } from '@nestjs/swagger'; import { PrismaClient as AppPrismaClient } from '@prisma/app-client'; import { randomUUID } from 'crypto'; import { AppService } from './app.service'; import { AppDemo } from './generated/rest/dto/app_demo'; export class AppData { // <- updates @ApiProperty({ type: String }) message: string; } @Controller() export class AppController { constructor( @InjectPrismaClient() private readonly appPrismaClient: AppPrismaClient, private readonly appService: AppService ) {} @Get() @ApiResponse({ type: AppData }) // <- updates getData() { return this.appService.getData(); } @Post('/demo') @ApiCreatedResponse({ type: AppDemo }) // <- updates async demoCreateOne() { return await this.appPrismaClient.appDemo.create({ data: { name: 'demo name' + randomUUID() } }); } @Get('/demo/:id') @ApiResponse({ type: AppDemo }) // <- updates async demoFindOne(@Param('id') id: string) { return await this.appPrismaClient.appDemo.findFirstOrThrow({ where: { id } }); } @Delete('/demo/:id') @ApiResponse({ type: AppDemo }) // <- updates async demoDeleteOne(@Param('id') id: string) { return await this.appPrismaClient.appDemo.delete({ where: { id } }); } @Get('/demo') @ApiResponse({ type: AppDemo, isArray: true }) // <- updates async demoFindMany() { return await this.appPrismaClient.appDemo.findMany(); } } 

import { provideHttpClient } from '@angular/common/http'; import { ApplicationConfig, importProvidersFrom, provideZoneChangeDetection } from '@angular/core'; import { provideClientHydration } from '@angular/platform-browser'; import { provideRouter } from '@angular/router'; import { RestClientApiModule, RestClientConfiguration } from '@nestjs-mod-fullstack/app-angular-rest-sdk'; import { appRoutes } from './app.routes'; export const appConfig: ApplicationConfig = { providers: [ provideClientHydration(), provideZoneChangeDetection({ eventCoalescing: true }), provideRouter(appRoutes), provideHttpClient(), importProvidersFrom( RestClientApiModule.forRoot( () => new RestClientConfiguration({ basePath: 'http://localhost:3000', }) ) ), ], }; 

import { Component, OnInit, ViewEncapsulation } from '@angular/core'; import { RouterModule } from '@angular/router'; import { DefaultRestService } from '@nestjs-mod-fullstack/app-angular-rest-sdk'; import { NxWelcomeComponent } from './nx-welcome.component'; @Component({ standalone: true, imports: [NxWelcomeComponent, RouterModule], selector: 'app-root', templateUrl: './app.component.html', styleUrl: './app.component.scss', encapsulation: ViewEncapsulation.None, }) export class AppComponent implements OnInit { title = 'client'; serverMessage!: string; constructor(private readonly defaultRestService: DefaultRestService) {} ngOnInit() { this.defaultRestService.appControllerGetData().subscribe((result) => (this.serverMessage = result.message)); } } 

import { HttpClientModule } from '@angular/common/http'; import { TestBed } from '@angular/core/testing'; import { RouterModule } from '@angular/router'; import { RestClientApiModule, RestClientConfiguration } from '@nestjs-mod-fullstack/app-angular-rest-sdk'; import { AppComponent } from './app.component'; import { NxWelcomeComponent } from './nx-welcome.component'; describe('AppComponent', () => { beforeEach(async () => { await TestBed.configureTestingModule({ imports: [ AppComponent, NxWelcomeComponent, RouterModule.forRoot([]), HttpClientModule, // <- updates RestClientApiModule.forRoot( // <- updates () => new RestClientConfiguration({ basePath: 'http://localhost:3000', }) ), ], }).compileComponents(); }); it('should render title', () => { const fixture = TestBed.createComponent(AppComponent); fixture.detectChanges(); const compiled = fixture.nativeElement as HTMLElement; expect(compiled.querySelector('h1')?.textContent).toContain('Welcome client'); }); it(`should have as title 'client'`, () => { const fixture = TestBed.createComponent(AppComponent); const app = fixture.componentInstance; expect(app.title).toEqual('client'); }); }); 

import { Configuration, DefaultApi } from '@nestjs-mod-fullstack/app-rest-sdk'; describe('GET /api', () => { const defaultApi = new DefaultApi(new Configuration({ basePath: '/api' })); let newDemoObject: { id: string }; it('should return a message', async () => { const res = await defaultApi.appControllerGetData(); expect(res.status).toBe(200); expect(res.data).toEqual({ message: 'Hello API' }); }); it('should create and return a demo object', async () => { const res = await defaultApi.appControllerDemoCreateOne(); expect(res.status).toBe(201); expect(res.data.name).toContain('demo name'); newDemoObject = res.data; }); it('should get demo object by id', async () => { const res = await defaultApi.appControllerDemoFindOne(newDemoObject.id); expect(res.status).toBe(200); expect(res.data).toMatchObject(newDemoObject); }); it('should get all demo object', async () => { const res = await defaultApi.appControllerDemoFindMany(); expect(res.status).toBe(200); expect(res.data.filter((row) => row.id === newDemoObject.id)).toMatchObject([newDemoObject]); }); it('should delete demo object by id', async () => { const res = await defaultApi.appControllerDemoDeleteOne(newDemoObject.id); expect(res.status).toBe(200); expect(res.data).toMatchObject(newDemoObject); }); it('should get all demo object', async () => { const res = await defaultApi.appControllerDemoFindMany(); expect(res.status).toBe(200); expect(res.data.filter((row) => row.id === newDemoObject.id)).toMatchObject([]); }); }); 

npm run test 

./node_modules/.bin/nx run-many --exclude=@nestjs-mod-fullstack/source --all -t=e2e --skip-nx-cache=true --output-style=stream-without-prefixes