Merge pull request #316 from daniloab/fix/channels-path

fix(channels): channels path for asyncapi
Surnet · Apr 18, 2022 · 4b50b92 · 4b50b92
2 parents 7141ec4 + dfca1e1
commit 4b50b92
Show file tree

Hide file tree

Showing 10 changed files with 28 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -69,6 +69,7 @@ yarn add swagger-jsdoc
 
 - OpenAPI 3.x
 - Swagger 2
+- AsyncAPI 2.0
 
 ## Documentation
 

diff --git a/examples/eventDriven/openapiConfig.js → examples/eventDriven/asyncApiConfig.js b/examples/eventDriven/openapiConfig.js → examples/eventDriven/asyncApiConfig.js
@@ -2,7 +2,7 @@ module.exports = {
   info: {
     title: 'User Event API',
     version: '1.0.0',
+    description: ' User Event API Specification',
   },
-  description: ' User Event API Specification',
-  openapi: '3.0.0',
+  asyncapi: '2.0.0',
 };
diff --git a/examples/eventDriven/src/customSpec.json b/examples/eventDriven/src/customSpec.json
@@ -1,11 +1,10 @@
 {
   "info": {
     "title": "User Event API",
-    "version": "1.0.0"
+    "version": "1.0.0",
+    "description": " User Event API Specification"
   },
-  "description": " User Event API Specification",
-  "openapi": "3.0.0",
-  "paths": {},
+  "asyncapi": "2.0.0",
   "components": {
     "messages": {
       "UserSignedIn": {

diff --git a/examples/eventDriven/src/customSpec.yml b/examples/eventDriven/src/customSpec.yml
@@ -1,9 +1,8 @@
 info:
   title: User Event API
   version: 1.0.0
-description: " User Event API Specification"
-openapi: 3.0.0
-paths: {}
+  description: " User Event API Specification"
+asyncapi: 2.0.0
 components:
   messages:
     UserSignedIn:

diff --git a/src/specification.js b/src/specification.js
@@ -18,7 +18,6 @@ const {
  * @returns {object} swaggerObject
  */
 function prepare(definition) {
-  let version;
   const swaggerObject = JSON.parse(JSON.stringify(definition));
   const specificationTemplate = {
     v2: [
@@ -35,18 +34,28 @@ function prepare(definition) {
       'parameters',
       'securityDefinitions',
       'components',
-      'channels',
     ],
+    v4: ['components', 'channels'],
   };
 
-  if (swaggerObject.openapi) {
-    version = 'v3';
-  } else if (swaggerObject.swagger) {
-    version = 'v2';
-  } else {
-    version = 'v2';
+  const getVersion = () => {
+    if (swaggerObject.asyncapi) {
+      return 'v4';
+    }
+
+    if (swaggerObject.openapi) {
+      return 'v3';
+    }
+
+    if (swaggerObject.swagger) {
+      return 'v2';
+    }
+
     swaggerObject.swagger = '2.0';
-  }
+    return 'v2';
+  };
+
+  const version = getVersion();
 
   specificationTemplate[version].forEach((property) => {
     swaggerObject[property] = swaggerObject[property] || {};

diff --git a/test/cli.spec.js b/test/cli.spec.js
@@ -123,15 +123,15 @@ describe('CLI module', () => {
 
   it('should generate json final file from separated files', async () => {
     const result = await sh(
-      `${bin} -d examples/eventDriven/openapiConfig.js examples/eventDriven/src/modules/**/*.yml -o examples/eventDriven/src/customSpec.json`
+      `${bin} -d examples/eventDriven/asyncApiConfig.js examples/eventDriven/src/modules/**/*.yml -o examples/eventDriven/src/customSpec.json`
     );
 
     expect(result.stdout).toMatchSnapshot();
   });
 
   it('should generate yml final file from separated files', async () => {
     const result = await sh(
-      `${bin} -d examples/eventDriven/openapiConfig.js examples/eventDriven/src/modules/**/*.yml -o examples/eventDriven/src/customSpec.yml`
+      `${bin} -d examples/eventDriven/asyncApiConfig.js examples/eventDriven/src/modules/**/*.yml -o examples/eventDriven/src/customSpec.yml`
     );
 
     expect(result.stdout).toMatchSnapshot();

diff --git a/test/files/v3/callback/openapi.json b/test/files/v3/callback/openapi.json
@@ -79,6 +79,5 @@
     }
   },
   "components": {},
-  "channels": {},
   "tags": []
 }
diff --git a/test/files/v3/links/openapi.json b/test/files/v3/links/openapi.json
@@ -61,6 +61,5 @@
       }
     }
   },
-  "channels": {},
   "tags": []
 }
diff --git a/test/files/v3/petstore/openapi.json b/test/files/v3/petstore/openapi.json
@@ -152,6 +152,5 @@
       }
     }
   },
-  "channels": {},
   "tags": []
 }
diff --git a/test/lib.spec.js b/test/lib.spec.js
@@ -111,7 +111,6 @@ describe('Main lib module', () => {
         },
         paths: {},
         components: {},
-        channels: {},
         tags: [],
       });
     });