Merge pull request #88 from logoran/master

add openapi support
APIDevTools · May 25, 2018 · ebefa13 · ebefa13
2 parents 07575d7 + 27ac9de
commit ebefa13
Show file tree

Hide file tree

Showing 8 changed files with 7,718 additions and 6,289 deletions.
diff --git a/dist/swagger-parser.js b/dist/swagger-parser.js
diff --git a/dist/swagger-parser.js.map b/dist/swagger-parser.js.map
diff --git a/dist/swagger-parser.min.js b/dist/swagger-parser.min.js
diff --git a/dist/swagger-parser.min.js.map b/dist/swagger-parser.min.js.map
diff --git a/lib/index.js b/lib/index.js
@@ -58,24 +58,46 @@ SwaggerParser.prototype.parse = function (path, api, options, callback) {
 
   return $RefParser.prototype.parse.call(this, args.path, args.schema, args.options)
     .then(function (schema) {
-      var supportedSwaggerVersions = ['2.0'];
+      if (schema.swagger) {
+        var supportedVersions = ['2.0'];
 
-      // Verify that the parsed object is a Swagger API
-      if (schema.swagger === undefined || schema.info === undefined || schema.paths === undefined) {
-        throw ono.syntax('%s is not a valid Swagger API definition', args.path || args.schema);
-      }
-      else if (typeof schema.swagger === 'number') {
-        // This is a very common mistake, so give a helpful error message
-        throw ono.syntax('Swagger version number must be a string (e.g. "2.0") not a number.');
-      }
-      else if (typeof schema.info.version === 'number') {
-        // This is a very common mistake, so give a helpful error message
-        throw ono.syntax('API version number must be a string (e.g. "1.0.0") not a number.');
-      }
-      else if (supportedSwaggerVersions.indexOf(schema.swagger) === -1) {
-        throw ono.syntax(
-          'Unsupported Swagger version: %d. Swagger Parser only supports version %s',
-          schema.swagger, supportedSwaggerVersions.join(', '));
+        // Verify that the parsed object is a Swagger API
+        if (schema.swagger === undefined || schema.info === undefined || schema.paths === undefined) {
+          throw ono.syntax('%s is not a valid Swagger API definition', args.path || args.schema);
+        }
+        else if (typeof schema.swagger === 'number') {
+          // This is a very common mistake, so give a helpful error message
+          throw ono.syntax('Swagger version number must be a string (e.g. "2.0") not a number.');
+        }
+        else if (typeof schema.info.version === 'number') {
+          // This is a very common mistake, so give a helpful error message
+          throw ono.syntax('API version number must be a string (e.g. "1.0.0") not a number.');
+        }
+        else if (supportedVersions.indexOf(schema.swagger) === -1) {
+          throw ono.syntax(
+            'Unsupported Swagger version: %d. Swagger Parser only supports version %s',
+            schema.swagger, supportedVersions.join(', '));
+        }
+      } else {
+        var supportedVersions = ['3.0.0', '3.0.1'];
+
+        // Verify that the parsed object is a Openapi API
+        if (schema.openapi === undefined || schema.info === undefined || schema.paths === undefined) {
+          throw ono.syntax('%s is not a valid Openapi API definition', args.path || args.schema);
+        }
+        else if (typeof schema.openapi === 'number') {
+          // This is a very common mistake, so give a helpful error message
+          throw ono.syntax('Openapi version number must be a string (e.g. "3.0.0") not a number.');
+        }
+        else if (typeof schema.info.version === 'number') {
+          // This is a very common mistake, so give a helpful error message
+          throw ono.syntax('API version number must be a string (e.g. "1.0.0") not a number.');
+        }
+        else if (supportedVersions.indexOf(schema.openapi) === -1) {
+          throw ono.syntax(
+            'Unsupported Openapi version: %d. Openapi Parser only supports version %s',
+            schema.openapi, supportedVersions.join(', '));
+        }
       }
 
       // Looks good!

diff --git a/lib/validators/schema.js b/lib/validators/schema.js
@@ -3,7 +3,8 @@
 var util = require('../util'),
     ono = require('ono'),
     ZSchema = require('z-schema'),
-    swaggerSchema = require('swagger-schema-official/schema.json');
+    swaggerSchema = require('swagger-schema-official/schema.json'),
+    openapiSchema = require('openapi-schema-validation/schema/openapi-3.0.json');
 
 module.exports = validateSchema;
 
@@ -18,7 +19,11 @@ function validateSchema (api) {
   util.debug('Validating against the Swagger 2.0 schema');
 
   // Validate the API against the Swagger schema
-  var isValid = ZSchema.validate(api, swaggerSchema);
+  if (api.swagger) {
+    var isValid = ZSchema.validate(api, swaggerSchema);
+  } else {
+    var isValid = ZSchema.validate(api, openapiSchema);
+  }
 
   if (isValid) {
     util.debug('    Validated successfully');

diff --git a/package.json b/package.json
@@ -78,8 +78,9 @@
     "debug": "^3.1.0",
     "json-schema-ref-parser": "^5.0.3",
     "ono": "^4.0.5",
+    "openapi-schema-validation": "^0.4.1",
     "swagger-methods": "^1.0.4",
     "swagger-schema-official": "2.0.0-bab6bed",
     "z-schema": "^3.19.1"
   }
-}
+}
diff --git a/test/specs/invalid/invalid.spec.js b/test/specs/invalid/invalid.spec.js
@@ -7,7 +7,7 @@ describe('Invalid APIs (can\'t be parsed)', function () {
       .then(helper.shouldNotGetCalled)
       .catch(function (err) {
         expect(err).to.be.an.instanceOf(SyntaxError);
-        expect(err.message).to.contain('not-swagger.yaml is not a valid Swagger API definition');
+        expect(err.message).to.contain('not-swagger.yaml is not a valid Openapi API definition');
       });
   });