DX: Make it easier to use API gateway base URL in environment variables

This post http://www.goingserverless.com/blog/api-gateway-url outlines how to grab the base API gateway url from cloud-formation.

This is a pretty common url case and prevents folks from having to hardcode strings

It works but is god awful to write. No human should ever ever ever ever ever ever have to write:

{ "Fn::Join" : ["", [ "https://", { "Ref" : "ApiGatewayRestApi" }, ".execute-api.${self:custom.region}.amazonaws.com/${self:custom.stage}" ] ]  }

Here is a working serverless.yml example:

service: the-service

custom:
  stage: "${opt:stage, self:provider.stage}"
  region: "${opt:region, self:provider.region}"

provider:
  name: aws
  runtime: nodejs6.10
  environment:
    IT_WORKS: { "Fn::Join" : ["", [ "https://", { "Ref" : "ApiGatewayRestApi" }, ".execute-api.${self:custom.region}.amazonaws.com/${self:custom.stage}" ] ]  }

functions:
  myFunc:
    handler: handler.test
    events:
      - http:
          path: whatever
          method: post
          cors: true

// hander.js
module.exports.test = (event, context, callback) => {
  console.log('API URL IT_WORKS', process.env.IT_WORKS)
  // now I can call other urls of service without hardcoding stuff
}

Suggestion: Make a shorthand variable to reference this instead of the verbose cloudformation.

Something like: ${apiGatewayUrl} (or something)

Let’s make it easy to write and read! =)

[mim-Armand]

AN old topic but thought I’d share this and bump it so we close it if it’s not needed anymore, I use this and it works fine:

baseUrl: ${cf:my-api-name-${self:provider.stage}.ServiceEndpoint}

[medikoo]

I’m closing it for two reasons:

1. AFAIK API Gateway API url (as generated by AWS) cannot be known until actual API is deployed - therefore trying to attach to it in properties which are required for a deployment of a stack, cannot work (at least not for first deployment)
2. For cases where API was already deployed a solution posted in this comment https://github.com/serverless/serverless/issues/3986#issuecomment-481964975 by @mim-Armand feels as most appropriate way to address this use case.

Let me know if missed something