feat(serverless-openapi): render openapi automatically on package hook and add output option to serverless.yaml

Author: Nightapes

packages/serverless-openapi/README.md

@@ -31,6 +31,14 @@ If you want to change the format (json or yaml) or the file name use
 serverless openapi -o openapi.yaml
 ```
 
+or set it via serverless yaml
+
+```yml
+custom:
+  openapi:
+    out: openapi.yaml
+```
+
 ### Add basic info and tags
 
 Under `custom` add

packages/serverless-openapi/src/index.ts

@@ -1,5 +1,5 @@
 import Serverless from 'serverless';
-import { customProperties } from './lib/custom.properties';
+import { CustomProperties, customProperties } from './lib/custom.properties';
 import { OpenAPIV3 } from 'openapi-types';
 import { writeFileSync } from 'fs';
 import { functioneventProperties } from './lib/functionEvent.properties';
@@ -47,17 +47,19 @@ export class ServerlessPlugin {
 
     this.hooks = {
       'openapi:serverless': this.generate.bind(this),
+      'package:initialize': this.generate.bind(this),
     };
   }
 
   private generate() {
     this.serverless.cli.log('Generate open api');
     const openApi = new Generator().generate(this.serverless);
-    this.saveToFile(openApi);
+    const customOpenApi = this.serverless.service.custom
+      .openapi as CustomProperties;
+    this.saveToFile(openApi, customOpenApi.out);
   }
 
-  private saveToFile(openApi: OpenAPIV3.Document) {
-    let out = 'openapi.json';
+  private saveToFile(openApi: OpenAPIV3.Document, out = 'openapi.json') {
     if (this.options['out']) {
       out = this.options['out'];
     }

packages/serverless-openapi/src/lib/custom.properties.ts

@@ -1,11 +1,26 @@
 import { JSONSchema7 } from 'json-schema';
+import { Schema } from './response.types';
+
+export interface CustomProperties {
+  out?: string;
+  version: string;
+  title: string;
+  description?: string;
+  tags?: { name: string; description?: string }[];
+  defaultResponse?: {
+    'application/json': Schema;
+  };
+}
 
 export const customProperties: JSONSchema7 = {
   properties: {
     openapi: {
       type: 'object',
       additionalProperties: false,
       properties: {
+        out: {
+          type: 'string',
+        },
         version: {
           type: 'string',
         },

packages/serverless-openapi/src/lib/generator.ts

@@ -1,23 +1,8 @@
 import Serverless from 'serverless';
-import { JSONSchema7 } from 'json-schema';
 import { OpenAPIV3 } from 'openapi-types';
 import { HttpMethod } from 'serverless/plugins/aws/package/compile/events/apiGateway/lib/validate';
-
-interface Schema {
-  schema?: JSONSchema7;
-  name: string;
-  description?: string;
-}
-
-interface CustomProperties {
-  version: string;
-  title: string;
-  description?: string;
-  tags?: { name: string; description?: string }[];
-  defaultResponse?: {
-    'application/json': Schema;
-  };
-}
+import { Schema } from './response.types';
+import { CustomProperties } from './custom.properties';
 
 interface HttpEvent {
   path: string;

packages/serverless-openapi/src/lib/response.types.ts

@@ -0,0 +1,7 @@
+import { JSONSchema7 } from 'json-schema';
+
+export interface Schema {
+  schema?: JSONSchema7;
+  name: string;
+  description?: string;
+}