Merge pull request #21 from ProtocolNebula/feature/9-support-swagger-1

Feature/9 support swagger 1

Author: ProtocolNebula

changelog.md

@@ -8,11 +8,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### 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)
+- Added **but not used** [swagger2openapi](https://github.com/Mermade/oas-kit/) to future validations (and first method to convert Swagger 2 to OpenAPI V3 with this library)
+- Support for `Swagger 1` and `Swagger 2 (Open API)` files (using [api-spec-converter](https://github.com/LucyBot-Inc/api-spec-converter) 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

package.json

@@ -56,6 +56,7 @@
     "email": "project@hostname.com"
   },
   "dependencies": {
+    "api-spec-converter": "^2.11.2",
     "case": "^1.6.1",
     "fs-extra": "^7.0.1",
     "fs": "0.0.1-security",

src/services/parsers/file-reader.service.ts

@@ -72,17 +72,32 @@ export class FileReaderService {
         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;
+        return this.convertFile('swagger_2', document);
+      case '1':
+        return this.convertFile('swagger_1', document);
       default:
         throw 'This OpenAPi/Swagger version is not compatible with this tool';
     }
   }
 
+  /**
+   * Convert from file definition to OpenAPI V3
+   * @param from
+   * @param document
+   * @url https://github.com/LucyBot-Inc/api-spec-converter
+   */
+  private async convertFile(
+    from: string,
+    document: any,
+  ): Promise<OpenAPIV3.Document> {
+    const Converter = require('api-spec-converter');
+    return Converter.convert({
+      from,
+      to: 'openapi_3',
+      source: 'https://api.gettyimages.com/swagger/api-docs',
+    });
+  }
+
   private async prepareFile(): Promise<void> {
     let extension = fileExtension(this.path);
     if (!fileIsJSON(this.path) && !fileIsYAML(this.path)) {