Use provider REST API ID (#78)

* Honour provider API Gateway Rest API ID.

* Remove console debugging.

* Add unit tests for shared API Gateway suppport.

* Simplify tests for shared API Gateway.

Author: dspasojevic

src/index.js

@@ -32,9 +32,21 @@ class ServerlessAWSDocumentation {
 
     this.cfTemplate = this.serverless.service.provider.compiledCloudFormationTemplate;
 
+    // The default rest API reference
+    let restApiId = {
+      Ref: 'ApiGatewayRestApi',
+    };
+
+    // Use the provider API gateway if one has been provided.
+    if (this.serverless.service.provider.apiGateway && this.serverless.service.provider.apiGateway.restApiId) {
+      restApiId = this.serverless.service.provider.apiGateway.restApiId
+    }
+
     if (this.customVars.documentation.models) {
+      const cfModelCreator = this.createCfModel(restApiId);
+
       // Add model resources
-      const models = this.customVars.documentation.models.map(this.createCfModel)
+      const models = this.customVars.documentation.models.map(cfModelCreator)
         .reduce((modelObj, model) => {
           modelObj[`${model.Properties.Name}Model`] = model;
           return modelObj;
@@ -51,9 +63,7 @@ class ServerlessAWSDocumentation {
     // Add models
     this.cfTemplate.Outputs.AwsDocApiId = {
       Description: 'API ID',
-      Value: {
-        Ref: 'ApiGatewayRestApi',
-      },
+      Value: restApiId,
     };
   }
 

src/index.spec.js

@@ -570,6 +570,100 @@ describe('ServerlessAWSDocumentation', function () {
       });
     });
 
+    it('should use the provider rest api id', function () {
+      this.serverlessMock.variables.service.custom.documentation.models = [{
+        name: 'CreateResponseJson',
+        contentType: "application/json",
+        schema: {
+          type: 'object'
+        }
+      }];
+      this.serverlessMock.service._functionNames = ['test'];
+      this.serverlessMock.service._functions = {
+        test: {
+          events: [{
+            http: {
+              path: 'some/path',
+              method: 'post',
+              cors: true,
+              private: true,
+              documentation: {
+                methodResponses: [
+                  {
+                    statusCode: 200,
+                    responseModels: {
+                      'application/json': 'CreateResponseJson',
+                    },
+                    responseHeaders: [{
+                      name: 'x-header',
+                      description: 'THE header',
+                    }],
+                  },
+                ],
+              }
+            },
+          }],
+        },
+      };
+      this.serverlessMock.service.provider.apiGateway = {
+        restApiId: {
+          'Fn::ImportValue': 'PublicApiGatewayRestApi'
+        }
+      };
+
+      const resources = this.serverlessMock.service.provider.compiledCloudFormationTemplate.Resources;
+      resources.somepath_post = {
+        some: 'configuration',
+        Properties: {},
+      };
+
+      this.plugin.beforeDeploy();
+
+      expect(this.serverlessMock.service.provider.compiledCloudFormationTemplate).toEqual({
+        Resources: {
+          ExistingResource: {
+            with: 'configuration',
+          },
+          somepath_post: {
+            some: 'configuration',
+            DependsOn: ['CreateResponseJsonModel'],
+            Properties: {
+              MethodResponses: [{
+                StatusCode: '200',
+                ResponseModels: {
+                  'application/json': 'CreateResponseJson',
+                },
+                ResponseParameters: {
+                  'method.response.header.x-header': true,
+                },
+              }],
+            },
+          },
+          CreateResponseJsonModel: {
+            Type: 'AWS::ApiGateway::Model',
+            Properties: {
+              RestApiId: {
+                'Fn::ImportValue': 'PublicApiGatewayRestApi'
+              },
+              ContentType: 'application/json',
+              Name: 'CreateResponseJson',
+              Schema: {
+                type: 'object'
+              }
+            }
+          },
+        },
+        Outputs: {
+          AwsDocApiId: {
+            Description: 'API ID',
+            Value: {
+              'Fn::ImportValue': 'PublicApiGatewayRestApi',
+            },
+          }
+        },
+      });
+    });
+
     it('should only add response methods with existing MethodResponses to ApiGateway methods', function () {
       this.serverlessMock.variables.service.custom.documentation.models = [];
       this.serverlessMock.service._functionNames = ['test'];

src/models.js

@@ -1,6 +1,6 @@
 'use strict';
 
-function replaceModelRefs(cfModel) {
+function replaceModelRefs(restApiId, cfModel) {
     if (!cfModel.Properties || !cfModel.Properties.Schema || Object.keys(cfModel.Properties.Schema).length == 0) {
       return cfModel;
     }
@@ -15,7 +15,7 @@ function replaceModelRefs(cfModel) {
                             '/',
                             [
                                 'https://apigateway.amazonaws.com/restapis',
-                                { Ref: 'ApiGatewayRestApi' },
+                                restApiId,
                                 'models',
                                 match[1]
                             ]
@@ -40,18 +40,20 @@ function replaceModelRefs(cfModel) {
 }
 
 module.exports = {
-  createCfModel: function createCfModel(model) {
-    return replaceModelRefs({
-      Type: 'AWS::ApiGateway::Model',
-      Properties: {
-        RestApiId: {
-          Ref: 'ApiGatewayRestApi',
-        },
-        ContentType: model.contentType,
-        Name: model.name,
-        Schema: model.schema || {},
-      },
-    });
+  createCfModel: function createCfModel(restApiId) {
+    return function(model) {
+      return replaceModelRefs(restApiId,
+        {
+          Type: 'AWS::ApiGateway::Model',
+          Properties: {
+            RestApiId: restApiId,
+            ContentType: model.contentType,
+            Name: model.name,
+            Schema: model.schema || {},
+          },
+        }
+      );
+    }
   },
 
   addModelDependencies: function addModelDependencies(models, resource) {

src/models.spec.js

@@ -16,7 +16,9 @@ describe('ServerlessAWSDocumentation', function() {
                 }
             };
 
-            let modelOutput = objectUnderTest.createCfModel(modelInput);
+            let modelOutput = objectUnderTest.createCfModel({
+                Ref: 'ApiGatewayRestApi',
+            })(modelInput);
             expect(modelOutput).toEqual({
                 Type: 'AWS::ApiGateway::Model',
                 Properties: {
@@ -52,6 +54,58 @@ describe('ServerlessAWSDocumentation', function() {
             });
         });
 
+        it('should use provided rest api setting', () => {
+            let modelInput = {
+                contentType: 'application/json',
+                name: 'TestModel',
+                schema: {
+                    type: 'object',
+                    properties: {
+                        prop: {
+                            '$ref': '{{model: OtherModelName}}'
+                        }
+                    }
+                }
+            };
+
+            let modelOutput = objectUnderTest.createCfModel({
+                'Fn::ImportValue': 'PublicApiGatewayRestApi',
+            })(modelInput);
+            expect(modelOutput).toEqual({
+                Type: 'AWS::ApiGateway::Model',
+                Properties: {
+                    RestApiId: {
+                        'Fn::ImportValue': 'PublicApiGatewayRestApi',
+                    },
+                    ContentType: 'application/json',
+                    Name: 'TestModel',
+                    Schema: {
+                        type: 'object',
+                        properties: {
+                            prop: {
+                                '$ref': {
+                                    'Fn::Join': [
+                                        '/',
+                                        [
+                                            'https://apigateway.amazonaws.com/restapis',
+                                            {
+                                                'Fn::ImportValue': 'PublicApiGatewayRestApi'
+                                            },
+                                            'models',
+                                            'OtherModelName'
+                                        ]
+                                    ]
+                                }
+                            }
+                        }
+                    }
+                },
+                DependsOn: [
+                    'OtherModelNameModel'
+                ]
+            });
+        });
+
         it('should not mess with non-ref model definitions', () => {
             let modelInput = {
                 contentType: 'application/json',
@@ -66,7 +120,9 @@ describe('ServerlessAWSDocumentation', function() {
                 }
             };
 
-            let modelOutput = objectUnderTest.createCfModel(modelInput);
+            let modelOutput = objectUnderTest.createCfModel({
+                Ref: 'ApiGatewayRestApi',
+            })(modelInput);
             expect(modelOutput).toEqual({
                 Type: 'AWS::ApiGateway::Model',
                 Properties: {