feat: add postman support

Author: hosseinmd

package.json

@@ -37,6 +37,7 @@
     "axios": ">=0.27",
     "chalk": "^4.1.2",
     "js-yaml": "^4.1.0",
+    "postman-to-openapi": "^2.4.1",
     "qs": "^6.11.0",
     "recursive-readdir": "^2.2.2",
     "swagger2openapi": "^7.0.8",

readme.md

@@ -6,9 +6,9 @@
 
 # Swagger-Typescript: Generate ts/js code from swagger/openApi JSON
 
-Support OpenApi v3 and swagger v2
+Support OpenApi v3, swagger v2 and postman collection
 
-An auto typescript/javascript code generator from swagger.
+An auto typescript/javascript code generator from APIs doc.
 Each endpoint will be created as a function, full type base.
 Supported
 
@@ -81,7 +81,7 @@ For Example:
 
 | [`Key`]              | [`default`]      | Comment                                                                                                                                                                                                                                        |
 | -------------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `url`                | Required         | Address of swagger.json ([specific branch](#specific-branch))                                                                                                                                                                                  |
+| `url`                | Required         | swagger or postman collection Address. can be online or local (json/yaml) ([specific branch](#specific-branch))                                                                                                                                |
 | `dir`                | Required         | Address of output                                                                                                                                                                                                                              |
 | `language`           | `typescript`     | export to "javascript" or "typescript"                                                                                                                                                                                                         |
 | `methodName`         | `{method}{path}` | Supported mixed of "{method}{path}{operationId}". for Example: 'service{method}{path}'                                                                                                                                                         |

src/getJson.ts

@@ -1,16 +1,26 @@
 import Axios from "axios";
+import { readFileSync } from "fs";
 import yaml from "js-yaml";
 
 async function getJson(url: string) {
-  process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
+  let input;
+  if (url.startsWith("http")) {
+    process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
+    const { data } = await Axios.get(url);
 
-  const { data } = await Axios.get(url);
+    // if url is yaml file convert it to json
+    input = data;
+  } else {
+    const data = readFileSync(url).toString();
+    input = data;
+  }
 
-  // if url is yaml file convert it to json
-  if (typeof data === "object") {
-    return data;
+  if (typeof input === "object") {
+    return input;
+  } else if (url.endsWith("json")) {
+    return JSON.parse(input);
   }
-  return yaml.load(data);
+  return yaml.load(input);
 }
 
 export { getJson };

src/index.ts

@@ -6,6 +6,8 @@ import { getCurrentUrl, majorVersionsCheck } from "./utils";
 import { swaggerToOpenApi } from "./utilities/swaggerToOpenApi";
 import chalk from "chalk";
 import { partialUpdateJson } from "./updateJson";
+import postmanToOpenApi from "postman-to-openapi";
+import yaml from "js-yaml";
 
 /** @param config If isn't defined will be use swagger.config.json instead */
 async function generate(config?: SwaggerConfig, cli?: Partial<Config>) {
@@ -53,8 +55,12 @@ const generateService = async (config: Config, cli?: Partial<Config>) => {
         // convert swagger v2 to openApi v3
         config._isSwagger2 = true;
         input = await swaggerToOpenApi(input);
-      } else {
+      } else if (input.openapi) {
         majorVersionsCheck("3.0.0", input.openapi);
+      } else {
+        input = yaml.load(
+          await postmanToOpenApi(JSON.stringify(input), undefined),
+        ) as SwaggerJson;
       }
     }
 
@@ -111,8 +117,7 @@ function getLocalJson(dir: string) {
   const swaggerJsonPath = `${dir}/swagger.json`;
 
   try {
-    const old = readFileSync(swaggerJsonPath).toString();
-    return JSON.parse(old);
+    return readJson(swaggerJsonPath);
   } catch (error) {
     chalk.red(
       "swagger.json file not found. You should set keepJson true to save json then run swag-ts without tag to save that",
@@ -121,4 +126,9 @@ function getLocalJson(dir: string) {
   }
 }
 
+function readJson(path: string) {
+  const old = readFileSync(path).toString();
+  return JSON.parse(old);
+}
+
 export { generate };

swagger.config.json

@@ -34,5 +34,17 @@
         "terminalId"
       ]
     }
+  },
+  {
+    "url": "./testFiles/Wms.postman_collection.json",
+    "dir": "./test/postman",
+    "language": "typescript",
+    "ignore": {
+      "headerParams": [
+        "Accept",
+        "Content-Encoding",
+        "Content-Type"
+      ]
+    }
   }
 ]