feat(api-client): interface generated for service mocking purposes

README.md

@@ -130,6 +130,7 @@ output
  │   │  ...
  │   ├─ another.model.ts
  │   └─ index.ts
+ ├─ api-client.interface.ts
  ├─ api-client.service.ts
  └─ index.ts
 ```

src/generator.ts

@@ -47,8 +47,11 @@ export async function generateAPIClient(options: GenOptions): Promise<void> {
           if (!existsSync(outputPath)) {
             await ensureDir(outputPath);
           }
-          await generateClient(mustacheData, outputPath);
-          await generateModels(mustacheData, outputPath);
+          await Promise.all([
+            generateClient(mustacheData, outputPath),
+            generateClientInterface(mustacheData, outputPath),
+            generateModels(mustacheData, outputPath),
+          ]);
           if (!options.skipModuleExport) {
             await generateModuleExportIndex(mustacheData, outputPath);
           }
@@ -63,7 +66,15 @@ async function generateClient(viewContext: MustacheData, outputPath: string): Pr
   const clientTemplate = (await promisify(readFile)(`${__dirname}/../templates/ngx-service.mustache`)).toString();
 
   const result = Mustache.render(clientTemplate, viewContext);
-  const outfile = join(outputPath, `${viewContext.fileName}.ts`);
+  const outfile = join(outputPath, `${viewContext.serviceFileName}.ts`);
+
+  await promisify(writeFile)(outfile, result, 'utf-8');
+}
+
+async function generateClientInterface(viewContext: MustacheData, outputPath: string): Promise<void> {
+  const template = (await promisify(readFile)(`${__dirname}/../templates/ngx-service-interface.mustache`)).toString();
+  const result = Mustache.render(template, viewContext);
+  const outfile = join(outputPath, `${viewContext.interfaceFileName}.ts`);
 
   await promisify(writeFile)(outfile, result, 'utf-8');
 }

src/helper.ts

@@ -1,4 +1,5 @@
 import { Spec as Swagger, Path, Operation } from 'swagger-schema-official';
+import { FileInfix } from './types';
 
 export const BASIC_TS_TYPE_REGEX = /\b(string|number|integer|boolean)\b/;
 const BUILD_IN_TS_TYPE_REGEX = /\b(string|number|integer|boolean|null|undefined|any|Object|Date|File|Blob)\b/;
@@ -78,7 +79,7 @@ export function typeName(name: string = 'any', isArray: boolean = false): string
   return `${type}${isArray ? '[]' : ''}`;
 }
 
-export function fileName(name: string = '', type: 'model' | 'enum' | 'service' = 'model'): string {
+export function fileName(name: string = '', type: FileInfix = 'model'): string {
   return `${dashCase(name)}.${type}`;
 }
 

src/parser.ts

@@ -53,7 +53,9 @@ export function createMustacheViewModel(swagger: Swagger, swaggerTag?: string):
     methods: methods,
     definitions: parseDefinitions(swagger.definitions, swagger.parameters, swaggerTag ? methods : undefined),
     serviceName: swaggerTag ? `${swaggerTag}Service` : 'APIClient',
-    fileName: fileName(swaggerTag ? swaggerTag : 'api-client', 'service')
+    serviceFileName: fileName(swaggerTag ? swaggerTag : 'api-client', 'service'),
+    interfaceName: swaggerTag ? `${swaggerTag}Interface` : 'APIClientInterface',
+    interfaceFileName: fileName(swaggerTag ? swaggerTag : 'api-client', 'interface'),
   };
 }
 

src/types.ts

@@ -21,12 +21,15 @@ export interface MustacheData {
   readonly methods: Method[];
   readonly definitions: Definition[];
   readonly serviceName: string;
-  readonly fileName: string;
+  readonly serviceFileName: string;
+  readonly interfaceName: string;
+  readonly interfaceFileName: string;
 }
 
 export type TypescriptBasicTypes = 'string' | 'number' | 'boolean' | 'undefined' | 'any';
 export type In = 'body' | 'path' | 'query' | 'modelbinding' | 'header' | 'formData';
 export type MethodType = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+export type FileInfix = 'model' | 'enum' | 'service' | 'interface';
 
 export interface Property {
   readonly camelCaseName?: string;

templates/ngx-module-export.mustache

@@ -8,7 +8,8 @@ import { {{&serviceName}}, USE_DOMAIN, USE_HTTP_OPTIONS } from './api-client.ser
 export * from './models';
 {{/definitions.length}}
 
-export { {{&serviceName}} } from './{{&fileName}}';
+export { {{&serviceName}} } from './{{&serviceFileName}}';
+export { {{&interfaceName}} } from './{{&interfaceFileName}}';
 
 /**
  * provided options, headers and params will be used as default for each request
@@ -51,4 +52,4 @@ export class {{&serviceName}}Module {
       ]
     };
   }
-}
+}

templates/ngx-service-interface.mustache

@@ -0,0 +1,26 @@
+/* tslint:disable */
+
+import { Observable } from 'rxjs';
+import { HttpOptions } from './';
+import * as models from './models';
+
+export interface {{&interfaceName}} {
+
+{{#methods}}
+  {{#description}}
+  /**
+   * {{&.}}
+   */
+{{/description}}  {{&methodName}}(
+  {{#parameters.length}}
+    args: {
+    {{#parameters}}
+      {{&camelCaseName}}{{^isRequired}}?{{/isRequired}}: {{importType}}{{#isArray}}[]{{/isArray}},{{#description}}  //{{^isRequired}} (optional){{/isRequired}} {{&.}}{{/description}}
+    {{/parameters}}
+    },
+  {{/parameters.length}}
+    requestHttpOptions?: HttpOptions
+  ): Observable<{{&response}}>;
+
+{{/methods}}
+}

templates/ngx-service.mustache

@@ -3,7 +3,7 @@
 import { HttpClient, HttpHeaders, HttpParams } from '@angular/common/http';
 import { Inject, Injectable, InjectionToken, Optional } from '@angular/core';
 import { Observable, throwError } from 'rxjs';
-import { DefaultHttpOptions, HttpOptions } from './';
+import { DefaultHttpOptions, HttpOptions, {{&interfaceName}} } from './';
 
 {{#definitions.length}}
 import * as models from './models';
@@ -21,7 +21,7 @@ type APIHttpOptions = HttpOptions & {
  * Created with https://github.com/flowup/api-client-generator
  */
 @Injectable()
-export class {{&serviceName}} {
+export class {{&serviceName}} implements {{&interfaceName}} {
 
   readonly options: APIHttpOptions;
 

tests/custom/api/api-client.interface.ts

@@ -0,0 +1,46 @@
+/* tslint:disable */
+
+import { Observable } from 'rxjs';
+import { HttpOptions } from './';
+import * as models from './models';
+
+export interface APIClientInterface {
+
+  getItems(
+    args: {
+      pageSize: number,
+      page: number,  // page number
+    },
+    requestHttpOptions?: HttpOptions
+  ): Observable<models.ItemList>;
+
+  getItemModels(
+    args: {
+      pageSize: number,
+      page: number,  // page number
+    },
+    requestHttpOptions?: HttpOptions
+  ): Observable<any>;
+
+  getPetsId(
+    args: {
+      id: string,
+    },
+    requestHttpOptions?: HttpOptions
+  ): Observable<any>;
+
+  deletePetsId(
+    args: {
+      id: string,
+    },
+    requestHttpOptions?: HttpOptions
+  ): Observable<any>;
+
+  patchPetsId(
+    args: {
+      id: string,
+    },
+    requestHttpOptions?: HttpOptions
+  ): Observable<any>;
+
+}

tests/custom/api/api-client.service.ts

@@ -3,7 +3,7 @@
 import { HttpClient, HttpHeaders, HttpParams } from '@angular/common/http';
 import { Inject, Injectable, InjectionToken, Optional } from '@angular/core';
 import { Observable, throwError } from 'rxjs';
-import { DefaultHttpOptions, HttpOptions } from './';
+import { DefaultHttpOptions, HttpOptions, APIClientInterface } from './';
 
 import * as models from './models';
 
@@ -19,7 +19,7 @@ type APIHttpOptions = HttpOptions & {
  * Created with https://github.com/flowup/api-client-generator
  */
 @Injectable()
-export class APIClient {
+export class APIClient implements APIClientInterface {
 
   readonly options: APIHttpOptions;
 

tests/custom/api/index.ts

@@ -7,6 +7,7 @@ import { APIClient, USE_DOMAIN, USE_HTTP_OPTIONS } from './api-client.service';
 export * from './models';
 
 export { APIClient } from './api-client.service';
+export { APIClientInterface } from './api-client.interface';
 
 /**
  * provided options, headers and params will be used as default for each request
@@ -49,4 +50,4 @@ export class APIClientModule {
       ]
     };
   }
-}
+}