swaggerjsontoapidocs 1.1.0 → 1.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Esteban Fernandez <efernandezdev@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,201 @@
+# swaggerjsontoapidocs CLI
+
+This project is a Command Line Interface (CLI) tool that generates API documentation from a Swagger JSON file. It is developed in TypeScript and uses Node.js.
+
+## Installation
+
+Make sure you have Node.js installed on your system. Then, install the project dependencies by running:
+
+```bash
+npm install swaggerjsontoapidocs
+```
+
+```bash
+npm install swaggerjsontoapidocs -g
+```
+
+## Usage
+
+The CLI script is executed using the following command:
+
+```bash
+npx swaggerjsontoapidocs [options]
+```
+
+### Available Arguments
+
+- `-s, --swagger <url>`: Specifies the URL of the Swagger JSON file.
+- `-bp, --basePath <path>`: Defines the base path where the API documentation will be generated.
+
+### Example Usage
+
+```bash
+npx swaggerjsontoapidocs -s http://localhost:5033/swagger/v1/swagger.json --bp /api/
+```
+
+In this example:
+
+- `-s` points to the URL of the Swagger JSON file.
+- `-bp` defines the base path `/api/` where the documentation will be generated.
+
+<details>
+  <summary>Swagger.json (Click to expand)</summary>
+
+```json
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "fakeApi",
+    "version": "1.0"
+  },
+  "paths": {
+    "/api/Users": {
+      "get": {
+        "tags": ["Users"],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Usuario"
+                  }
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Usuario"
+                  }
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Usuario"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/Users/{id}": {
+      "get": {
+        "tags": ["Users"],
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/Usuario"
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Usuario"
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Usuario"
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "tags": ["Users"],
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/Usuario"
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Usuario"
+                }
+              },
+              "text/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Usuario"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Usuario": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "nullable": true
+          },
+          "nombre": {
+            "type": "string",
+            "nullable": true
+          },
+          "email": {
+            "type": "string",
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  }
+}
+```
+
+</details>
+
+### Result
+
+```typescript
+// Users.ts
+export const Users = () => `Users`;
+/**
+ * @param id
+ */
+export const Users_id = (id: any) => `Users/${id}`;
+```
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for more details.

package/dist/index.js

@@ -1,86 +1,48 @@
 #!/usr/bin/env node
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = require("fs");
 const chalk_1 = __importDefault(require("chalk"));
-const readline = __importStar(require("node:readline/promises"));
 const node_path_1 = __importDefault(require("node:path"));
+const yargs_1 = __importDefault(require("yargs"));
+const helpers_1 = require("yargs/helpers");
 const jsonToApiDocs_1 = require("./jsonToApiDocs");
+const argv = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+    .options({
+    swagger: {
+        alias: "s",
+        type: "string",
+        demandOption: true,
+        describe: "URL of the swagger.json file, e.g.: http://localhost:5033/swagger/v1/swagger.json",
+    },
+    bp: {
+        type: "string",
+        demandOption: true,
+        describe: "Basepath to remove from endpoints, e.g.: /api/",
+    },
+})
+    .version()
+    .help()
+    .alias("help", "h")
+    .strict()
+    .parseSync();
 async function main() {
-    console.log(chalk_1.default.green("To configure the script correctly, you must ensure that BE is running and you can view the Swagger page.".toUpperCase()));
-    console.log(chalk_1.default.red("Have the PATH of the swagger.json and the BASEPATH which will determine how the endpoints will be returned."));
-    await promptConfigFile();
-    (0, jsonToApiDocs_1.initScript)();
-}
-async function promptConfigFile() {
-    return new Promise((resolve) => {
-        (async () => {
-            const rl = readline.createInterface({
-                input: process.stdin,
-                output: process.stdout,
-            });
-            let pathInputValid = true;
-            let basepathInputValid = true;
-            let pathInput = "";
-            let basepathInput = "";
-            while (pathInputValid) {
-                pathInput = await rl.question("Copy the correct path to download the swagger.json file, e.g.: http://localhost:5033/swagger/v1/swagger.json: ");
-                if (pathInput.trim().length > 0) {
-                    pathInputValid = false;
-                }
-            }
-            while (basepathInputValid) {
-                basepathInput = await rl.question("Enter the basepath, e.g.: /api/ to deleted of path /api/Users/{id} => return export const Users_id = (id: any) => `Users/${id}`:");
-                if (basepathInput.trim().length > 0) {
-                    basepathInputValid = false;
-                }
-            }
-            rl.close();
-            (0, fs_1.writeFile)(node_path_1.default.join(__dirname, "config.json"), `{"BASEPATH": "${basepathInput.trim()}","PATH": "${pathInput.trim()}"}`, "utf8", async (err) => {
-                if (err) {
-                    console.error(err);
-                }
-                else {
-                    resolve();
-                }
-            });
-        })();
+    console.log(chalk_1.default.green("CONFIGURING THE SCRIPT WITH THE PROVIDED ARGUMENTS..."));
+    const swaggerPath = argv.swagger;
+    const basePath = argv.bp;
+    console.log(chalk_1.default.blue(`Swagger Path: ${swaggerPath}`));
+    console.log(chalk_1.default.blue(`Basepath: ${basePath}`));
+    (0, fs_1.writeFile)(node_path_1.default.join(__dirname, "config.json"), `{"BASEPATH": "${basePath.trim()}","PATH": "${swaggerPath.trim()}"}`, "utf8", (err) => {
+        if (err) {
+            console.error(chalk_1.default.red("Error writing the configuration file:"), err);
+        }
+        else {
+            console.log(chalk_1.default.green("Configuration file created successfully."));
+            (0, jsonToApiDocs_1.initScript)();
+        }
     });
 }
 main();

package/dist/jsonToApiDocs.js

@@ -42,6 +42,8 @@ const promises_1 = require("fs/promises");
 const path = __importStar(require("path"));
 const chalk_1 = __importDefault(require("chalk"));
 const prettier_1 = require("prettier");
+const os_1 = __importDefault(require("os"));
+const child_process_1 = require("child_process");
 const mainFolderOutPut = path.join(__dirname, "api_docs");
 let urlSwaggerJson = "";
 let basepath = "";
@@ -142,6 +144,30 @@ async function makeFileContainer(endpoints, foldersName) {
         }
     }
     console.log(`💾 show result ---> ${mainFolderOutPut}`);
+    openFileManager(mainFolderOutPut);
+}
+function openFileManager(fullPath) {
+    const platform = os_1.default.platform();
+    let command = "";
+    switch (platform) {
+        case "win32":
+            command = `explorer "${fullPath}"`;
+            break;
+        case "darwin":
+            command = `open "${fullPath}"`;
+            break;
+        case "linux":
+            command = `xdg-open "${fullPath}"`;
+            break;
+        default:
+            console.error(`Platform ${platform} is not supported.`);
+            return;
+    }
+    (0, child_process_1.exec)(command, (error) => {
+        if (error) {
+            console.error(`Error attempting to open folder: ${error.message}`);
+        }
+    });
 }
 async function formatWhitPrettier(filePath) {
     const content = await (0, promises_1.readFile)(filePath, "utf8");

package/package.json

@@ -1,33 +1,37 @@
 {
   "name": "swaggerjsontoapidocs",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "script to convert swagger json to api docs, this help us to consume functions and center all endpoints in one place",
   "main": "index.ts",
   "scripts": {
     "build": "tsc",
-    "api": "ts-node ./src/",
-    "dist": "node ./dist/",
-    "lint": "eslint ."
+    "api": "ts-node ./src/index.ts",
+    "dist": "node ./dist/index.js",
+    "lint": "eslint .",
+    "prepublishOnly": "npm run build"
   },
   "author": "Esteban Fernandez",
-  "license": "ISC",
+  "license": "MIT",
   "dependencies": {
-    "chalk": "^5.6.2",
-    "prettier": "^3.7.4"
+    "chalk": "5.6.2",
+    "prettier": "3.7.4",
+    "yargs": "18.0.0"
   },
   "devDependencies": {
-    "@eslint/js": "^9.39.2",
-    "@types/prettier": "^2.7.3",
-    "eslint": "^9.39.2",
-    "globals": "^17.0.0",
-    "jiti": "^2.6.1",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.52.0",
-    "ts-node": "^10.9.2"
+    "@eslint/js": "9.39.2",
+    "@types/prettier": "2.7.3",
+    "@types/yargs": "17.0.35",
+    "eslint": "9.39.2",
+    "globals": "17.0.0",
+    "jiti": "2.6.1",
+    "ts-node": "10.9.2",
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.52.0"
   },
   "files": [
     "dist",
-    "package.json"
+    "package.json",
+    "!dist/api_docs"
   ],
   "engines": {
     "node": ">=15.0.0"