Merge pull request #264 from daniloab/feat/openapi-channels

feat(openapi): add support for channels

examples/eventDriven/openapiConfig.js

@@ -0,0 +1,8 @@
+module.exports = {
+  info: {
+    title: 'User Event API',
+    version: '1.0.0',
+  },
+  description: ' User Event API Specification',
+  openapi: '3.0.0',
+};

examples/eventDriven/src/customSpec.json

@@ -0,0 +1,52 @@
+{
+  "info": {
+    "title": "User Event API",
+    "version": "1.0.0"
+  },
+  "description": "User Event API Specification",
+  "openapi": "3.0.0",
+  "paths": {},
+  "components": {
+    "messages": {
+      "UserSignedIn": {
+        "payload": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string",
+              "description": "Id of the user"
+            }
+          }
+        }
+      },
+      "UserSignedUp": {
+        "payload": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string",
+              "description": "Id of the user"
+            }
+          }
+        }
+      }
+    }
+  },
+  "channels": {
+    "user/signedin": {
+      "subscribe": {
+        "message": {
+          "$ref": "#/components/messages/UserSignedIn"
+        }
+      }
+    },
+    "user/signedup": {
+      "subscribe": {
+        "message": {
+          "$ref": "#/components/messages/UserSignedUp"
+        }
+      }
+    }
+  },
+  "tags": []
+}

examples/eventDriven/src/customSpec.yml

@@ -0,0 +1,32 @@
+info:
+  title: User Event API
+  version: 1.0.0
+description: 'User Event API Specification'
+openapi: 3.0.0
+paths: {}
+components:
+  messages:
+    UserSignedIn:
+      payload:
+        type: object
+        properties:
+          id:
+            type: string
+            description: Id of the user
+    UserSignedUp:
+      payload:
+        type: object
+        properties:
+          id:
+            type: string
+            description: Id of the user
+channels:
+  user/signedin:
+    subscribe:
+      message:
+        $ref: '#/components/messages/UserSignedIn'
+  user/signedup:
+    subscribe:
+      message:
+        $ref: '#/components/messages/UserSignedUp'
+tags: []

examples/eventDriven/src/modules/userSignIn.ts

@@ -0,0 +1,6 @@
+// ou usersignin event it will be placed here
+export const userSignIn = (job: Job<{ userId: string }>) => {
+  const { userId } = job.data;
+
+  console.log("User Logged", userId);
+};

examples/eventDriven/src/modules/userSignIn.yml

@@ -0,0 +1,14 @@
+channels:
+  user/signedin:
+    subscribe:
+      message:
+        $ref: '#/components/messages/UserSignedIn'
+components:
+  messages:
+    UserSignedIn:
+      payload:
+        type: object
+        properties:
+          id:
+            type: string
+            description: Id of the user

examples/eventDriven/src/modules/userSignUp.ts

@@ -0,0 +1,5 @@
+export const userSignUp = (job: Job<{ userId: string }>) => {
+  const { userId } = job.data;
+
+  console.log("User Registered", userId);
+};

examples/eventDriven/src/modules/userSignUp.yml

@@ -0,0 +1,14 @@
+channels:
+  user/signedup:
+    subscribe:
+      message:
+        $ref: '#/components/messages/UserSignedUp'
+components:
+  messages:
+    UserSignedUp:
+      payload:
+        type: object
+        properties:
+          id:
+            type: string
+            description: Id of the user

src/specification.js

@@ -35,6 +35,7 @@ function prepare(definition) {
       'parameters',
       'securityDefinitions',
       'components',
+      'channels',
     ],
   };
 
@@ -136,6 +137,7 @@ function organize(swaggerObject, annotation, property) {
     'responses',
     'parameters',
     'definitions',
+    'channels',
   ];
   if (commonProperties.includes(property)) {
     for (const definition of Object.keys(annotation[property])) {

test/__snapshots__/cli.spec.js.snap

@@ -22,6 +22,16 @@ Options:
 "
 `;
 
+exports[`CLI module should generate json final file from separated files 1`] = `
+"Swagger specification is ready.
+"
+`;
+
+exports[`CLI module should generate yml final file from separated files 1`] = `
+"Swagger specification is ready.
+"
+`;
+
 exports[`CLI module should reject definition file with invalid JSON syntax 1`] = `
 "Error while loading definition file 'test/files/v2/wrong_syntax.json':
 Unexpected token t in JSON at position 18

test/cli.spec.js

@@ -121,6 +121,22 @@ describe('CLI module', () => {
     expect(result.stderr).toMatchSnapshot();
   });
 
+  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`
+    );
+
+    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`
+    );
+
+    expect(result.stdout).toMatchSnapshot();
+  });
+
   afterAll(() => {
     fs.unlinkSync(`${dir}/swagger.json`);
     fs.unlinkSync(`${dir}/customSpec.json`);