Mappatura delle fasi API a un nome di dominio personalizzato per le API WebSocket - Gateway Amazon API

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Mappatura delle fasi API a un nome di dominio personalizzato per le API WebSocket

È possibile utilizzare le mappature API per connettere le fasi API a un nome di dominio personalizzato. Dopo aver creato un nome di dominio e aver configurato i record DNS, è possibile utilizzare le mappature API per inviare il traffico alle API tramite il nome di dominio personalizzato.

Una mappatura API specifica un'API, una fase e, facoltativamente, un percorso da utilizzare per la mappatura. Ad esempio, è possibile mappare la fase production di un'API su wss://api.example.com/orders.

Prima di creare una mappatura API, è necessario disporre di un'API, di una fase e di un nome di dominio personalizzato. Per ulteriori informazioni sulla creazione di un nome di dominio personalizzato, consulta Configurazione di un nome di dominio personalizzato regionale in Gateway API.

Restrizioni

  • In una mappatura API, il nome di dominio personalizzato e le API mappate devono trovarsi nello stesso account AWS.

  • Le mappature API devono contenere solo lettere, numeri e i seguenti caratteri: $-_.+!*'().

  • La lunghezza massima per il percorso in una mappatura API è di 300 caratteri.

  • Non è possibile mappare le API WebSocket allo stesso nome di dominio personalizzato di un'API HTTP o un'API REST.

  • Se si crea una mappatura API con più livelli, Gateway API converte tutti i nomi di intestazione in lettere minuscole.

Creare una mappatura API

Per creare una mappatura API, innanzitutto è necessario creare un nome di dominio personalizzato, un'API e una fase. Per informazioni sulla creazione di un nome di dominio personalizzato, consulta Configurazione di un nome di dominio personalizzato regionale in Gateway API.

Console di gestione AWS
Per creare una mappatura API
  1. Accedere alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

  2. Scegliere Nomi di dominio personalizzati.

  3. Selezionare un nome di dominio personalizzato già creato.

  4. Scegliere API mappings (mappature API).

  5. Scegliere Configure API mappings (Configura mappature API).

  6. Scegliere Add new mapping (Aggiungi nuova mappatura).

  7. Immettere un'API, uno Stage (Fase)e, facoltativamente, un Path (Percorso).

  8. Selezionare Salva.

AWS CLI

Il comando create-api-mapping seguente crea una mappatura API. In questo esempio, API Gateway invia le richieste api.example.com/v1 all'API e alla fase specificate.

aws apigatewayv2 create-api-mapping \ --domain-name api.example.com \ --api-mapping-key v1 \ --api-id a1b2c3d4 \ --stage test
CloudFormation

Il seguente esempio di CloudFormation consente di creare una mappatura API.

MyApiMapping: Type: 'AWS::ApiGatewayV2::ApiMapping' Properties: DomainName: api.example.com ApiMappingKey: 'v1' ApiId: !Ref MyApi Stage: !Ref MyStage