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à.
Implementazione REST APIs in Gateway API
Dopo aver creato il tuoAPI, devi distribuirlo per renderlo richiamabile dai tuoi utenti.
Per distribuire unAPI, è necessario creare una API distribuzione e associarla a una fase. Una fase è un riferimento logico a uno stato del ciclo di vita dell'utente API (ad esempio,,, dev
prod
,beta
). v2
APIle fasi sono identificate dall'APIID e dal nome della fase. Sono inclusi in URL quello che usi per richiamare ilAPI. Ogni fase è un riferimento denominato a una distribuzione di API ed è resa disponibile per la chiamata delle applicazioni client.
Importante
Ogni volta che si aggiorna unaAPI, è necessario ridistribuirla API in una fase esistente o in una nuova fase. L'aggiornamento di un API include la modifica di percorsi, metodi, integrazioni, autorizzazioni, politiche delle risorse e qualsiasi altra cosa diversa dalle impostazioni dello stage.
Man mano che API si evolve, è possibile continuare a distribuirlo in fasi diverse come versioni diverse di. API Puoi anche distribuire i tuoi API aggiornamenti come distribuzione Canary Release. Ciò consente API ai vostri clienti di accedere, nella stessa fase, alla versione di produzione tramite la versione di produzione e alla versione aggiornata tramite la versione canary.
Per chiamare un deployedAPI, il client invia una richiesta contro un utente. API URL URLÈ determinato dal protocollo ((S) o HTTP (WSS)), dal nome host, dal nome della fase e dal percorso della risorsa (for RESTAPIs). API Il nome host e il nome dello stage determinano API la base. URL
Utilizzando il nome API di dominio predefinito, la base URL di a REST API (ad esempio) in una determinata fase (
) ha il seguente formato:{stageName}
https://
{restapi-id}
.execute-api.{region}
.amazonaws.com/{stageName}
Per rendere API la base predefinita URL più intuitiva, puoi creare un nome di dominio personalizzato (ad esempio,api.example.com
) per sostituire il nome host predefinito di. API Per supportare più utenti APIs con il nome di dominio personalizzato, è necessario mappare uno API stage su un percorso di base.
Con un nome di dominio personalizzato
e lo API stage mappato su un percorso base ({api.example.com}
) sotto il nome di dominio personalizzato, la base URL di a REST API diventa la seguente: {basePath}
https://
{api.example.com}
/{basePath}
Per ogni fase, puoi ottimizzare le API prestazioni regolando i limiti predefiniti di limitazione delle richieste a livello di account e abilitando la memorizzazione nella cache. API Puoi anche abilitare la registrazione delle API chiamate verso CloudTrail or CloudWatch e selezionare un certificato client per il backend per autenticare le richieste. API Inoltre, è possibile sovrascrivere le impostazioni a livello di fase per i singoli metodi e definire variabili di fase per passare contesti di ambiente specifici dello stadio all'integrazione in fase di esecuzione. API
Le fasi consentono un solido controllo della versione di. API Ad esempio, puoi API implementare an su uno test
stage e uno prod
stage e utilizzare lo test
stage come build di test e utilizzare lo prod
stage come build stabile. Dopo che gli aggiornamenti hanno superato il test, puoi promuovere la fase test
alla fase prod
. La promozione può essere effettuata ridistribuendo lo stage API to the prod
stage o aggiornando il valore di una variabile di stage dal nome della fase test
a quello di. prod
In questa sezione, discutiamo come implementare un API utilizzando la console API Gateway o chiamando il Gateway