CodeGenieApp/serverless-express

BasePathMapping

Open

#596 opened on Dec 11, 2022

View on GitHub
 (2 comments) (1 reaction) (0 assignees)JavaScript (4,977 stars) (674 forks)batch import
help wanted

Description

Hello, I'm trying to use a custom domain but I have the following error:

I'm using example: basic-starter-api-gateway-v2-typescript/

CREATE_FAILED                         AWS::ApiGateway::BasePathMapping      MyApiBasePathMapping

Resource handler returned message: 
Mixing of REST APIs and HTTP APIs  
on the same domain name can only be 
accomplished through API Gateway's  
V2 DomainName interface. Currently, 
WebSocket APIs can only be attached 
to a domain name with other         
WebSocket APIs. This must also      
occur through API Gateway's V2      
DomainName interface. (Service:     
ApiGateway, Status Code: 400,       
Request ID: 5187005f-3413-47bb-b777 
-6c98784001d0

Contributor guide

Tech stack
javascripttypescriptnodejsaws
Domain
backendapicloud
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic AWS API Gateway knowledgeFamiliarity with serverless express examples
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the serverless express repository, focusing on the 'basic starter api gateway v2 typescript' example. The issue arises from mixing REST and HTTP APIs on the same custom domain. To resolve, update the example to use the API Gateway V2 DomainName interface for BasePathMapping. Check the AWS CloudFormation template in the example and ensure the domain name is configured using AWS::ApiGatewayV2::DomainName and AWS::ApiGatewayV2::ApiMapping instead of AWS::ApiGateway::BasePathMapping. Review any existing documentation or issues for similar guidance. Consider creating a PR that modifies the example or adds a note in the README about this limitation.