docs: update docs + examples for extra templates option

Author: js2me

CHANGELOG.md

@@ -10,6 +10,7 @@ onBuildRoutePath: (data: BuildRoutePath) => BuildRoutePath | void;
 onInsertPathParam: (paramName: string, index: number, arr: BuildRouteParam[], resultRoute: string) => string | void;
 ```
 feature: ability to modify route path params before insert them into string (request url, #446, with using hook `onInsertPathParam`)  
+docs: update docs for `extraTemplates` option  
 
 # 11.1.3  
 

README.md

@@ -139,6 +139,7 @@ generateApi({
   typePrefix: '',
   typeSuffix: '',
   addReadonly: false,
+  /** allow to generate extra files based with this extra templates, see more below */
   extraTemplates: [],
   anotherArrayType: false, 
   codeGenConstructs: (constructs) => ({
@@ -239,8 +240,13 @@ with `--module-name-index 0` Api class will have one property `api`
 When we change it to `--module-name-index 1` then Api class have two properties `fruits` and `vegetables`  
 
 ### **`--module-name-first-tag`**  
-This option will group your API operations based on their first tag - mirroring how the Swagger UI groups displayed operations
+This option will group your API operations based on their first tag - mirroring how the Swagger UI groups displayed operations  
 
+### `extraTemplates` (NodeJS option)  
+type `(Record<string, any> & { name: string, path: string })[]`  
+This thing allow you to generate extra ts\js files based on extra templates (one extra template for one ts\js file)   
+[Example here](https://github.com/acacode/swagger-typescript-api/tree/next/tests/spec/extra-templates)    
+ 
 
 ## `generate-templates` command    
 This command allows you to generate source templates which using with option `--templates`

package.json

@@ -58,7 +58,8 @@
     "test:additionalProperties2.0": "node tests/spec/additional-properties-2.0/test.js",
     "test:enums2.0": "node tests/spec/enums-2.0/test.js",
     "test:another-query-params": "node tests/spec/another-query-params/test.js",
-    "test:on-insert-path-param": "node tests/spec/on-insert-path-param/test.js"
+    "test:on-insert-path-param": "node tests/spec/on-insert-path-param/test.js",
+    "test:extra-templates": "node tests/spec/extra-templates/test.js"
   },
   "author": "acacode",
   "license": "MIT",

tests/spec/extra-templates/expected.ts

@@ -0,0 +1,21 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+/**
+  Swagger Petstore
+  1.0.0
+  A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification
+*/
+export class Api {
+  private request(params: Record<string, any>) {
+    return fetch(params as any);
+  }
+}

tests/spec/extra-templates/external-template-name.ts

@@ -0,0 +1,21 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+/**
+  Swagger Petstore
+  1.0.0
+  A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification
+*/
+export class Api {
+  private request(params: Record<string, any>) {
+    return fetch(params as any);
+  }
+}

tests/spec/extra-templates/schema.json

@@ -0,0 +1,36 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Swagger Petstore",
+    "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification",
+    "termsOfService": "http://swagger.io/terms/",
+    "contact": {
+      "name": "Swagger API Team"
+    },
+    "license": {
+      "name": "MIT"
+    }
+  },
+  "host": "petstore.swagger.io",
+  "basePath": "/api",
+  "schemes": ["http"],
+  "consumes": ["application/json"],
+  "produces": ["application/json"],
+  "paths": {
+    "/wrong-path-params1/{pathParam1}/{path_param2}/{path_param3}/:pathParam4": {
+      "delete": {
+        "description": "DDD",
+        "operationId": "wrong-path-params1",
+        "parameters": [],
+        "produces": ["application/json"],
+        "responses": {
+          "200": { "description": "Successfully deleted" }
+        },
+        "tags": ["key", "delete"]
+      }
+    }
+  },
+  "definitions": {
+  }
+}

tests/spec/extra-templates/templates/test.ejs

@@ -0,0 +1,18 @@
+<%
+// console.info(it)
+%>
+
+/**
+  <%= it.apiConfig.info.title %>
+
+  <%= it.apiConfig.info.version %>
+
+  <%= it.apiConfig.info.description %>
+
+*/
+export class <%= it.config.apiClassName %> {
+    private request(params: Record<string, any>) {
+        return fetch(params as any)
+    }
+}
+

tests/spec/extra-templates/test.js

@@ -0,0 +1,32 @@
+const { generateApiForTest } = require("../../helpers/generateApiForTest");
+const { resolve } = require("path");
+const validateGeneratedModule = require("../../helpers/validateGeneratedModule");
+const assertGeneratedModule = require("../../helpers/assertGeneratedModule");
+const createSchemaInfos = require("../../helpers/createSchemaInfos");
+
+const schemas = createSchemaInfos({ absolutePathToSchemas: resolve(__dirname, "./") });
+
+schemas.forEach(({ absolutePath, apiFileName }) => {
+  generateApiForTest({
+    testName: "extra-templates test",
+    silent: true,
+    name: apiFileName,
+    input: absolutePath,
+    output: resolve(__dirname, "./"),
+    generateClient: false,
+    generateResponses: false,
+    generateRouteTypes: false,
+    generateUnionEnums: false,
+    templateExtensions: [".eta", ".ejs", ".ts"],
+    extraTemplates: [
+      {
+        name: "external-template-name",
+        path: resolve(__dirname, "./templates/test.ejs"),
+        metadata: { arg1: 100, arg2: 200 },
+      },
+    ],
+  }).then(() => {
+    validateGeneratedModule(resolve(__dirname, `./external-template-name.ts`));
+    assertGeneratedModule(resolve(__dirname, `./external-template-name.ts`), resolve(__dirname, `./expected.ts`));
+  });
+});

tests/spec/on-insert-path-param/test.js

@@ -8,7 +8,7 @@ const schemas = createSchemaInfos({ absolutePathToSchemas: resolve(__dirname, ".
 
 schemas.forEach(({ absolutePath, apiFileName }) => {
   generateApiForTest({
-    testName: "object-types test",
+    testName: "on-insert-path-param test",
     silent: true,
     name: apiFileName,
     input: absolutePath,