added usage clarification to README, introduced module index.ts

Author: aryobenholzner

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptNestjsServerCodegen.java

@@ -129,6 +129,7 @@ public String getHelp() {
     @Override
     public void processOpts() {
         super.processOpts();
+        supportingFiles.add(new SupportingFile("module.mustache", "", "index.ts"));
         supportingFiles.add(
                 new SupportingFile("models.mustache", modelPackage().replace('.', File.separatorChar), "index.ts"));
         supportingFiles

modules/openapi-generator/src/main/resources/typescript-nestjs-server/README.md

@@ -5,52 +5,52 @@ Usage: The generated output is intended to be its own module, that can be import
 Example usage (with the openapi sample `petstore.yaml`):
 
 1. Invoke openapi-generator
-```
-openapi-generator-cli.jar generate -i petstore.yaml -g typescript-nestjs-server -o api-module/
-```
-2. implement the contracts from `api-module/api`
-
-`handlers/PetService.ts`:
-```typescript
-import { Pet, ApiResponse } from "models";
-import { Observable } from "rxjs";
-import { PetApi } from "../api";
-import { Inject, Injectable } from "@nestjs/common";
-
-@Injectable()
-export class PetService implements PetApi {
-addPet(pet: Pet, request: Request): Pet | Promise<Pet> | Observable<Pet> {
-    throw new Error("Method not implemented.");
-    }
-
-    deletePet(petId: number, apiKey: string, request: Request): void | Promise<void> | Observable<void> {
-        throw new Error("Method not implemented.");
-        }
-
-...
-```
-
-3. Import the API Module with a reference to your implementation
-`app.module.ts`
-```typescript
-import { Module } from "@nestjs/common";
-import { ApiModule } from "api-module/api.module";
-import { PetService } from "./handlers/PetService";
-import { UserService } from "./handlers/UserService";
-import { StoreService } from "./handlers/StoreService";
-
-@Module({
-imports: [
-ApiModule.forRoot({
-petApi: PetService,
-userApi: UserService,
-storeApi: StoreService
-}),
-],
-controllers: [],
-providers: [],
-})
-export class AppModule {}
-```
+   ```
+   openapi-generator-cli.jar generate -i petstore.yaml -g typescript-nestjs-server -o api-module/
+   ```
+2. implement the contracts from `api-module/api`  
+   `handlers/PetService.ts`:
+   ```typescript
+   import { Pet, ApiResponse } from "models";
+   import { Observable } from "rxjs";
+   import { PetApi } from "../api";
+   import { Inject, Injectable } from "@nestjs/common";
+   
+   @Injectable()
+   export class PetService implements PetApi {
+     addPet(pet: Pet, request: Request): Pet | Promise<Pet> | Observable<Pet> {
+       throw new Error("Method not implemented.");
+     }
+   
+     deletePet(petId: number, apiKey: string, request: Request): void | Promise<void> | Observable<void> {
+       throw new Error("Method not implemented.");
+     }
+   
+   ...
+   ```
+3. Import the generated `ApiModule` with `ApiModule.forRoot` and provide a instance of `ApiImplementations` with a reference to your implementation  
+   `app.module.ts`
+   ```typescript
+   import { Module } from "@nestjs/common";
+   import { ApiModule, ApiImplementations } from "api-module";
+   import { PetService } from "./handlers/PetService";
+   import { UserService } from "./handlers/UserService";
+   import { StoreService } from "./handlers/StoreService";
+   
+   const apiImplementations: ApiImplementations = {
+     petApi: PetService,
+     userApi: UserService,
+     storeApi: StoreService,
+   }
+   
+   @Module({
+     imports: [
+       ApiModule.forRoot(apiImplementations),
+     ],
+     controllers: [],
+     providers: [],
+   })
+   export class AppModule {}
+   ```
 
 You now can regenerate the API module as often as you want without overriding your implementation.

modules/openapi-generator/src/main/resources/typescript-nestjs-server/module.mustache

@@ -0,0 +1,2 @@
+export * from './api.module'
+export * from './api-implementations'