[Fixed] How do i get/reference api gateway restapi id in serverless.yml?

Serverless Framework
5

For anyone else who finds this, note there’s some confusion here about API gateway resources.

  • The RestApiId is the id of the API resource itself, which is returned by a Ref of the implied ApiGatewayRestApi resource that Serverless creates under the hood.

  • The RootResourceId is the id of the REST resource (not to be confused with a CloudFormation resource!) at the root of the API’s path (i.e. “/”). If you are hanging methods or subresources off of root, you’ll need to provide this as the parent resource id. It is available as an attribute of the API resource.

So, for example to define a resource at the path “/mythings”, which needs both the api id and the root resource id, your CF template would look like

ThingsResource:
  Type: AWS::ApiGateway::Resource
  Properties:
    RestApiId:
      Ref: ApiGatewayRestApi
    ParentId:
      Fn::GetAtt:
        - ApiGatewayRestApi
        - RootResourceId
    PathPart: mythings

Hope this helps clarify.

5 Likes