Merge pull request #19 from ProtocolNebula/feature/8-18-openapi2-and-verify

ProtocolNebula · web-flow · commit d4b1ad968601 · 2021-01-11T01:22:30.000+01:00
Feature/8 support for swagger 2
diff --git a/changelog.md b/changelog.md
@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- Support for https remote files
+- Support for Swagger 2 files (added [swagger2openapi](https://github.com/Mermade/oas-kit/) which converts the file to OpenAPI V3)
+
+### Changed
+- APIs: If no `tags` provided, the URL is splitted and used as `tags`.
+- 
 ## [2.3.2] - 2021-01-09
 ### Addded
 - `--config-file` parameter
diff --git a/examples/generated/angular2/apis/Auth.ts b/examples/generated/angular2/apis/Auth.ts
@@ -1,5 +1,5 @@
-// THIS IS FILE IS AUTO-GENERATED
-// PLEASE, NOT MODIFY MANUALLY
+// THIS FILE IS AN AUTO GENERATED FILE
+// PLEASE, DO NOT MODIFY MANUALLY
 
 // Angular dependences
 import { Injectable } from '@angular/core';
diff --git a/examples/generated/angular2/apis/BookingManage.ts b/examples/generated/angular2/apis/BookingManage.ts
@@ -1,5 +1,5 @@
-// THIS IS FILE IS AUTO-GENERATED
-// PLEASE, NOT MODIFY MANUALLY
+// THIS FILE IS AN AUTO GENERATED FILE
+// PLEASE, DO NOT MODIFY MANUALLY
 
 // Angular dependences
 import { Injectable } from '@angular/core';
diff --git a/examples/generated/angular2/apis/BookingManageAvailability.ts b/examples/generated/angular2/apis/BookingManageAvailability.ts
@@ -1,5 +1,5 @@
-// THIS IS FILE IS AUTO-GENERATED
-// PLEASE, NOT MODIFY MANUALLY
+// THIS FILE IS AN AUTO GENERATED FILE
+// PLEASE, DO NOT MODIFY MANUALLY
 
 // Angular dependences
 import { Injectable } from '@angular/core';
diff --git a/examples/generated/angular2/apis/BookingManageDiscounts.ts b/examples/generated/angular2/apis/BookingManageDiscounts.ts
@@ -1,5 +1,5 @@
-// THIS IS FILE IS AUTO-GENERATED
-// PLEASE, NOT MODIFY MANUALLY
+// THIS FILE IS AN AUTO GENERATED FILE
+// PLEASE, DO NOT MODIFY MANUALLY
 
 // Angular dependences
 import { Injectable } from '@angular/core';
diff --git a/examples/generated/angular2/apis/BookingManageRoomPrices.ts b/examples/generated/angular2/apis/BookingManageRoomPrices.ts
@@ -1,5 +1,5 @@
-// THIS IS FILE IS AUTO-GENERATED
-// PLEASE, NOT MODIFY MANUALLY
+// THIS FILE IS AN AUTO GENERATED FILE
+// PLEASE, DO NOT MODIFY MANUALLY
 
 // Angular dependences
 import { Injectable } from '@angular/core';
diff --git a/examples/generated/angular2/apis/Direction.ts b/examples/generated/angular2/apis/Direction.ts
@@ -1,5 +1,5 @@
-// THIS IS FILE IS AUTO-GENERATED
-// PLEASE, NOT MODIFY MANUALLY
+// THIS FILE IS AN AUTO GENERATED FILE
+// PLEASE, DO NOT MODIFY MANUALLY
 
 // Angular dependences
 import { Injectable } from '@angular/core';
diff --git a/examples/generated/angular2/apis/FillingManage.ts b/examples/generated/angular2/apis/FillingManage.ts
@@ -1,5 +1,5 @@
-// THIS IS FILE IS AUTO-GENERATED
-// PLEASE, NOT MODIFY MANUALLY
+// THIS FILE IS AN AUTO GENERATED FILE
+// PLEASE, DO NOT MODIFY MANUALLY
 
 // Angular dependences
 import { Injectable } from '@angular/core';
diff --git a/examples/generated/angular2/apis/Game.ts b/examples/generated/angular2/apis/Game.ts
@@ -1,5 +1,5 @@
-// THIS IS FILE IS AUTO-GENERATED
-// PLEASE, NOT MODIFY MANUALLY
+// THIS FILE IS AN AUTO GENERATED FILE
+// PLEASE, DO NOT MODIFY MANUALLY
 
 // Angular dependences
 import { Injectable } from '@angular/core';
diff --git a/examples/generated/angular2/apis/OwnerRooms.ts b/examples/generated/angular2/apis/OwnerRooms.ts
@@ -1,5 +1,5 @@
-// THIS IS FILE IS AUTO-GENERATED
-// PLEASE, NOT MODIFY MANUALLY
+// THIS FILE IS AN AUTO GENERATED FILE
+// PLEASE, DO NOT MODIFY MANUALLY
 
 // Angular dependences
 import { Injectable } from '@angular/core';
diff --git a/examples/generated/angular2/apis/Search.ts b/examples/generated/angular2/apis/Search.ts
@@ -1,5 +1,5 @@
-// THIS IS FILE IS AUTO-GENERATED
-// PLEASE, NOT MODIFY MANUALLY
+// THIS FILE IS AN AUTO GENERATED FILE
+// PLEASE, DO NOT MODIFY MANUALLY
 
 // Angular dependences
 import { Injectable } from '@angular/core';
diff --git a/package.json b/package.json
@@ -64,6 +64,7 @@
     "js-yaml": "^3.14.1",
     "mkdir-recursive": "^0.4.0",
     "mustache": "^3.0.1",
+    "swagger2openapi": "^7.0.4",
     "yargs": "^12.0.5"
   },
   "devDependencies": {
diff --git a/src/services/parsers/file-reader.service.ts b/src/services/parsers/file-reader.service.ts
@@ -10,6 +10,8 @@ import {
 } from '../../utils/files.util';
 import { isURL } from '../../utils/string.util';
 
+const versionRegx = /^([0-9]+)/;
+
 /**
  * Main calss which parse the JSON/YAML file
  * If the file is a URL, it will download
@@ -30,7 +32,8 @@ export class FileReaderService {
 
   async readFile(): Promise<OpenAPIV3.Document> {
     await this.prepareFile();
-    this._document = await this.parseFile();
+    const document = await this.parseFile();
+    this._document = await this.upgradeFile(document);
     return this.document;
   }
 
@@ -51,6 +54,35 @@ export class FileReaderService {
     console.info('');
   }
 
+  async upgradeFile(document: any): Promise<OpenAPIV3.Document> {
+    let version: string;
+    if (document.openapi) {
+      version = versionRegx.exec(document.openapi)[1];
+    } else if (document.swagger) {
+      version = versionRegx.exec(document.swagger)[1];
+    }
+
+    if (!version) {
+      throw 'This is not a valid OpenApi/Swagger document';
+    }
+
+    console.info('Swagger/API version detected:', version);
+    switch (version) {
+      case '3':
+        return document;
+      case '2':
+        console.info('Convertin to OpenAPI V3');
+        const converter = require('swagger2openapi');
+        const converted = await converter.convertObj(document, {
+          patch: true,
+          warnOnly: true,
+        });
+        return converted.openapi;
+      default:
+        throw 'This OpenAPi/Swagger version is not compatible with this tool';
+    }
+  }
+
   private async prepareFile(): Promise<void> {
     let extension = fileExtension(this.path);
     if (!fileIsJSON(this.path) && !fileIsYAML(this.path)) {
@@ -70,7 +102,7 @@ export class FileReaderService {
     }
   }
 
-  private parseFile(): OpenAPIV3.Document {
+  private parseFile(): any {
     const filePath = this.localFilePath;
     switch (fileExtension(filePath)) {
       case 'yaml':
diff --git a/src/services/parsers/open-api-v3/api-parser.service.ts b/src/services/parsers/open-api-v3/api-parser.service.ts
@@ -30,7 +30,7 @@ export class APIParserService extends ParserBaseService {
       const verbRaw = rawModel[verb] as OpenAPIV3.OperationObject;
       console.group(verb.toUpperCase(), '-', verbRaw.operationId);
       const api = new ApiModel(url, verb);
-      api.tags = verbRaw.tags;
+      api.tags = verbRaw.tags || url.substr(1).split('/');
       api.description = verbRaw.summary;
       api.operationId = verbRaw.operationId;
 
diff --git a/src/utils/files.util.ts b/src/utils/files.util.ts
@@ -1,16 +1,23 @@
-import { createWriteStream, readdirSync, readFileSync, writeFileSync } from 'fs';
+import {
+  createWriteStream,
+  readdirSync,
+  readFileSync,
+  writeFileSync,
+} from 'fs';
 import * as http from 'http';
+import * as https from 'https';
 import * as yaml from 'js-yaml';
 import { mkdirSync } from 'mkdir-recursive';
 import { basename, dirname, extname, resolve as pathResolve } from 'path';
 import { config } from '../models/config.model';
 
 const getExtensionRegex = /(\.[a-z0-9]+).*/i;
+const isHttpsRegex = /^https/i;
 
 export function getAllFoldersFrom(path) {
   return readdirSync(path, { withFileTypes: true })
-    .filter(el => el.isDirectory())
-    .map(el => el.name);
+    .filter((el) => el.isDirectory())
+    .map((el) => el.name);
 }
 
 export function makeDir(dest): void {
@@ -22,7 +29,8 @@ export async function downloadFile(url, dest): Promise<string> {
   return new Promise((resolve, error) => {
     try {
       const file = createWriteStream(dest);
-      http.get(url, function (response) {
+      const protocol = isHttpsRegex.test(url) ? https : http;
+      protocol.get(url, function (response) {
         response.pipe(file);
         file.on('finish', () => {
           file.close();
