Configurar a API com integrações privadas usando o OpenAPI
Você pode configurar uma API com a integração privada importando o arquivo OpenAPI da API. As configurações são semelhantes às definições do OpenAPI de uma API com integrações de HTTP, com as seguintes exceções:
-
Você deve definir explicitamente
connectionType
comoVPC_LINK
. -
Você deve definir explicitamente
connectionId
como o ID de umVpcLink
ou como uma variável de estágio que faça referência ao ID de umVpcLink
. -
O parâmetro
uri
na integração privada aponta para um endpoint de HTTP/HTTPS na VPC, mas é usado para configurar o cabeçalhoHost
da solicitação de integração. -
O parâmetro
uri
na integração privada com um endpoint de HTTPS na VPC é usado para verificar o nome de domínio mencionado em relação ao nome no certificado instalado no VPC endpoint.
Você pode usar uma variável de estágio para fazer referência ao ID do VpcLink
. Ou você pode atribuir o valor do ID diretamente ao connectionId
.
O arquivo OpenAPI em formato JSON a seguir mostra um exemplo de API com um link de VPC referenciado por uma variável de estágio (${stageVariables.vpcLinkId}
):