Mappa API le fasi su un nome di dominio personalizzato per REST APIs - Amazon API Gateway

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à.

Mappa API le fasi su un nome di dominio personalizzato per REST APIs

Le API mappature vengono utilizzate per connettere le API fasi a un nome di dominio personalizzato. Dopo aver creato un nome di dominio e configurato DNS i record, utilizzi le API mappature per inviare traffico al tuo utente APIs tramite il tuo nome di dominio personalizzato.

Una API mappatura specifica unaAPI, una fase e, facoltativamente, un percorso da utilizzare per la mappatura. Ad esempio, è possibile mappare lo production stadio di un albero. API https://api.example.com/orders

Puoi mappare HTTP tutti gli REST API stage sullo stesso nome di dominio personalizzato.

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

Richieste di routing API

È possibile configurare API mappature con più livelli, ad esempio e. orders/v1/items orders/v2/items

Nota

Per configurare API mappature con più livelli, è necessario utilizzare un nome di dominio personalizzato regionale con la TLS politica di sicurezza 1.2.

Per le API mappature con più livelli, API Gateway indirizza le richieste alla API mappatura con il percorso corrispondente più lungo. APIGateway considera solo i percorsi configurati per le API mappature, e non i API percorsi, per selezionare quelli da richiamare. API Se nessun percorso corrisponde alla richiesta, API Gateway invia la richiesta a API quello che hai mappato sul percorso vuoto. (none)

Per i nomi di dominio personalizzati che utilizzano API mappature con più livelli, API Gateway indirizza le richieste alla API mappatura con il prefisso corrispondente più lungo.

Ad esempio, considera un nome https://api.example.com di dominio personalizzato con le seguenti mappature: API

  1. (none)mappato su 1. API

  2. ordersmappato su 2API.

  3. orders/v1/itemsmappato a 3. API

  4. orders/v2/itemsmappato a 4. API

  5. orders/v2/items/categoriesmappato a 5. API

Richiesta Selezionato API Spiegazione

https://api.example.com/orders

API 2

La richiesta corrisponde esattamente a questa API mappatura.

https://api.example.com/orders/v1/items

API 3

La richiesta corrisponde esattamente a questa API mappatura.

https://api.example.com/orders/v2/items

API 4

La richiesta corrisponde esattamente a questa API mappatura.

https://api.example.com/orders/v1/items/123

API 3

APIGateway sceglie la mappatura con il percorso corrispondente più lungo. 123 alla fine della richiesta non influisce sulla selezione.

https://api.example.com/orders/v2/items/categories/5

API 5

APIGateway sceglie la mappatura con il percorso corrispondente più lungo.

https://api.example.com/customers

API 1

APIGateway utilizza la mappatura vuota come soluzione generale.

https://api.example.com/ordersandmore

API 2

APIGateway sceglie la mappatura con il prefisso corrispondente più lungo.

Per un nome di dominio personalizzato configurato con mappature a livello singolo, ad esempio only https://api.example.com/orders and, API Gateway sceglierebbehttps://api.example.com/, poiché non esiste un percorso API 1 corrispondente con. ordersandmore

Restrizioni

  • In una API mappatura, il nome di dominio personalizzato e quello mappato APIs devono trovarsi nello stesso account. AWS

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

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

  • Puoi avere 200 API mappature con più livelli per ogni nome di dominio.

  • È possibile eseguire il mapping HTTP APIs solo su un nome di dominio personalizzato regionale con la politica di sicurezza TLS 1.2.

  • Non è possibile eseguire il mapping WebSocket APIs allo stesso nome di dominio personalizzato di un HTTP API or RESTAPI.

Creare una API mappatura

Per creare una API mappatura, devi prima creare un nome di dominio e uno stage API personalizzati. Per informazioni sulla creazione di un nome di dominio personalizzato, consulta Configura un nome di dominio personalizzato regionale in API Gateway.

Per esempio i AWS Serverless Application Model modelli che creano tutte le risorse, vedi Sessions With SAM on GitHub.

AWS Management Console
Per creare una API mappatura
  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. APIScegli le mappature.

  5. Scegli Configura mappature API.

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

  7. Inserisci uno API, uno stadio e, facoltativamente, un percorso.

  8. Seleziona Salva.

AWS CLI

Il AWS CLI comando seguente crea una API mappatura. In questo esempio, API Gateway invia le richieste api.example.com/v1/orders allo stadio API e specificato.

Nota

Per creare API mappature con più livelli, è necessario utilizzare. apigatewayv2

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

L' AWS CloudFormation esempio seguente crea una API mappatura.

Nota

Per creare API mappature con più livelli, è necessario utilizzare. AWS::ApiGatewayV2

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