Creare una distribuzione per un API gateway REST API in

In API Gateway, una REST API distribuzione è rappresentata da una risorsa Deployment. È simile a un eseguibile di un API che è rappresentato da una RestApirisorsa.

Affinché il client possa chiamare il tuoAPI, devi creare una distribuzione e associarvi una fase. Una fase è rappresentata da una risorsa Fase. Rappresenta un'istantanea diAPI, inclusi metodi, integrazioni, modelli, modelli di mappatura e autorizzatori Lambda (precedentemente noti come autorizzatori personalizzati). Quando si aggiorna ilAPI, è possibile ridistribuirlo associando una nuova fase alla API distribuzione esistente. La procedura di creazione di una fase è illustrata in Prepara un palco per un REST API in API Gateway.

Crea distribuzione

Le procedure seguenti mostrano come creare una distribuzione per un. REST API

AWS Management Console

È necessario averne creato uno REST API prima di distribuirlo per la prima volta. Per ulteriori informazioni, consulta Sviluppa REST APIs in API Gateway.

La console API Gateway consente di implementare an API creando una distribuzione e associandola a una fase nuova o esistente.

1. Accedere alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

2. Nel riquadro di APIsnavigazione, scegli API quello che desideri distribuire.

3. Nel riquadro Risorse, scegli Distribuisci API.

4. In Fase, procedi come segue:

   1. Per creare una nuova fase, seleziona Nuova fase, quindi immetti un nome in Nome fase. Facoltativamente, puoi immettere una descrizione dell'implementazione in Descrizione distribuzione.

   2. Per scegliere una fase esistente, seleziona il nome della fase nel menu a discesa. Se lo desideri, puoi specificare una descrizione della nuova implementazione in Descrizione distribuzione.

   3. Per creare un'implementazione non associata a una fase, seleziona Nessuna fase. Successivamente, puoi associare questa implementazione a una fase.

5. Seleziona Deploy (Implementa).

AWS CLI

Quando si crea una distribuzione, viene creata un'istanza della risorsa Distribuzione. È possibile utilizzare la console API Gateway, il AWS CLI AWS SDK, an o il API Gateway REST API per creare una distribuzione.

Per utilizzare il CLI per creare una distribuzione, usa il comando create-deployment:

 aws apigateway create-deployment --rest-api-id <rest-api-id> --region <region>

non API è richiamabile finché non si associa questa distribuzione a una fase. Con una fase esistente è possibile eseguire questa operazione aggiornando la proprietà deploymentId della fase con l'ID di distribuzione appena creato (<deployment-id>).

 aws apigateway update-stage --region <region> \
    --rest-api-id <rest-api-id> \ 
    --stage-name <stage-name> \ 
    --patch-operations op='replace',path='/deploymentId',value='<deployment-id>'

Quando si distribuisce una per API la prima volta, è possibile combinare la creazione della fase e la creazione della distribuzione contemporaneamente:

 aws apigateway create-deployment --region <region> \
    --rest-api-id <rest-api-id> \
    --stage-name <stage-name>

Questo è ciò che viene fatto dietro le quinte nella console API Gateway quando si distribuisce una console per API la prima volta o quando la si ridistribuisce in una nuova faseAPI.

Per ridistribuire unAPI, esegui la stessa procedura. Puoi riutilizzare la stessa fase tutte le volte che si desideri.

I passaggi successivi per la distribuzione API

Di seguito sono riportati i passaggi successivi per la API distribuzione.

Modifica le impostazioni dello stage

Dopo aver distribuito uno, API è possibile modificare le impostazioni dello stage per abilitare o disabilitare la API cache, la registrazione o la limitazione delle richieste. Puoi anche scegliere un certificato client per il backend per autenticare API Gateway e impostare le variabili di fase per passare il contesto di implementazione all'integrazione in fase di esecuzione. API Per ulteriori informazioni, consulta Modifica le impostazioni della fase

Dopo aver modificato le impostazioni della fase, è necessario ridistribuire le API affinché le modifiche abbiano effetto.

Nota

Se le impostazioni aggiornate, ad esempio l'abilitazione della registrazione, richiedono un nuovo IAM ruolo, è possibile aggiungere il IAM ruolo richiesto senza ridistribuire il. API Tuttavia, potrebbero essere necessari alcuni minuti prima che il nuovo IAM ruolo abbia effetto. Prima che ciò accada, le tracce delle API chiamate non vengono registrate anche se è stata abilitata l'opzione di registrazione.

Scegli diverse combinazioni in fase di implementazione

Poiché una distribuzione rappresenta un'APIistantanea e una fase definisce un percorso all'interno di un'istantanea, è possibile scegliere diverse combinazioni in fase di implementazione per controllare il modo in cui gli utenti richiamano le diverse versioni di. API Ciò è utile, ad esempio, quando si desidera ripristinare API lo stato di una distribuzione precedente o unire un «ramo privato» di una distribuzione a quella pubblica. API

La procedura seguente mostra come eseguire questa operazione utilizzando lo Stage Editor nella console Gateway. API Si presume che sia necessario averlo distribuito API più di una volta.

1. Se non sei già nel riquadro Fasi, nel pannello di navigazione principale, scegli Fasi.

2. Seleziona la fase da aggiornare.

3. Nella scheda Cronologia delle distribuzioni seleziona l'implementazione da utilizzare per la fase.

4. Scegli Cambia implementazione attiva.

5. Conferma di voler cambiare l'implementazione attiva e scegli Cambia implementazione attiva nella finestra di dialogo Rendi attiva l'implementazione.

Passa i dati specifici della distribuzione al tuo. API

Per una distribuzione, puoi impostare o modificare le variabili di fase per passare i dati specifici della distribuzione all'integrazione in fase di esecuzione. API Puoi eseguire questa operazione nella scheda Stage Variables (Variabili di fase) in Stage Editor (Editor fasi). Per ulteriori informazioni, consulta le istruzioni in Usa le variabili di fase per un REST API in API Gateway.