How can I export the AWS API Gateway Endpoints to file (or similar) after deploying?

Question

I am using the AWS API Gateway to mock different APIs and I want to use those endpoints in my application (which is not a lambda).

So my idea was to somehow reference those endpoints from a file like a json, but for that I need to get them exported every time I deploy.

Is there any way to archive this?

Answer 1

It depends on which stack you are using to deploy API gateway.

For example,

• Use Output for Cloudformation, see below example for reference, also check the doc to see the return value of APIGateway CFN resource. Then you can use AWS api/awscli to get the output of CloudFormation stack.

Outputs:
 myapi:
   Type: AWS::ApiGatewayV2::Api
   Properties:
     Name: MyAPI
     ProtocolType: HTTP
 APIEndpoint:
   Description: endpoint of api
   Value:
     Fn::Join:
       - ""
       - - https://
         - Ref: myapi
         - .execute-api.ap-southeast-1.amazonaws.com/
   Export:
     Name: APIEndpoint

• Outputs in terraform
• info command for serverless framework