Tutorial: creare un file REST API con un'HTTPintegrazione non proxy - Amazon API Gateway
Crea un file API con integrazione personalizzata HTTP(Facoltativo) Mappatura dei parametri di richiesta

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

Tutorial: creare un file REST API con un'HTTPintegrazione non proxy

In questo tutorial, ne crei una partendo API da zero utilizzando la console Amazon API Gateway. Puoi pensare alla console come a uno studio di API progettazione e utilizzarla per definire le API funzionalità, sperimentarne i comportamenti, crearla e distribuirla gradualmenteAPI. API

Crea un file API con integrazione personalizzata HTTP

Questa sezione illustra i passaggi per creare risorse, esporre metodi su una risorsa, configurare un metodo per ottenere API i comportamenti desiderati e testare e implementare il. API

In questo passaggio, crei un file vuoto. API Nei passaggi seguenti creerai risorse e metodi per connetterti API all'http://petstore-demo-endpoint.execute-api.com/petstore/petsendpoint, utilizzando un'integrazione non proxyHTTP.

Per creare un API

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

  2. Se è la prima volta che utilizzi API Gateway, viene visualizzata una pagina che presenta le funzionalità del servizio. In RESTAPI, scegli Costruisci. Quando viene visualizzato il API popup Crea esempio, scegli OK.

    Se non è la prima volta che usi API Gateway, scegli Crea API. In RESTAPI, scegli Build.

  3. Per APInome, inserisciHTTPNonProxyAPI.

  4. (Facoltativo) In Description (Descrizione), immettere una descrizione.

  5. Mantieni il tipo di API endpoint impostato su Regionale.

  6. Scegli Crea API.

L'albero Resources (Risorse) mostra la risorsa root (/) senza metodi. In questo esercizio, lo creeremo API con l'integrazione HTTP personalizzata del PetStore sito Web (http://petstore-demo-endpoint.execute-api. com/petstore/pets.) A scopo illustrativo, creeremo una /pets risorsa come elemento secondario della radice e mostreremo su questa risorsa un GET metodo per consentire a un cliente di recuperare un elenco di articoli Pets disponibili dal sito Web. PetStore

Per creare una risorsa /pets

  1. Scegli Crea risorsa.

  2. Mantieni l'opzione Risorsa proxy disattivata.

  3. Mantieni Percorso risorsa impostato su /.

  4. Per Resource Name (Nome risorsa) immetti pets.

  5. Mantieni CORS(Cross Origin Resource Sharing) disattivato.

  6. Scegli Crea risorsa.

In questa fase crei un metodo GET per la risorsa /pets. Il metodo GET è integrato con il sito Web http://petstore-demo-endpoint.execute-api.com/petstore/pets. Altre opzioni per un API metodo includono le seguenti:

  • POST, utilizzato principalmente per creare risorse per bambini.

  • PUT, utilizzato principalmente per aggiornare le risorse esistenti (e, sebbene non consigliato, può essere utilizzato per creare risorse secondarie).

  • DELETE, utilizzato per eliminare risorse.

  • PATCH, utilizzato per aggiornare le risorse.

  • HEAD, utilizzato principalmente negli scenari di test. È uguale GET ma non restituisce la rappresentazione delle risorse.

  • OPTIONS, che può essere utilizzato dai chiamanti per ottenere informazioni sulle opzioni di comunicazione disponibili per il servizio di destinazione.

Per il HTTPmetodo della richiesta di integrazione, devi sceglierne uno supportato dal backend. Per HTTP oMock integration, è logico che la richiesta del metodo e la richiesta di integrazione utilizzino lo stesso HTTP verbo. Per altri tipi di integrazione, la richiesta del metodo utilizzerà probabilmente un HTTP verbo diverso dalla richiesta di integrazione. Ad esempio, per chiamare una funzione Lambda, la richiesta di integrazione deve utilizzare POST per richiamare la funzione, mentre la richiesta del metodo può utilizzare qualsiasi HTTP verbo a seconda della logica della funzione Lambda.

Per creare un metodo GET nella risorsa /pets

  1. Seleziona la risorsa /pets.

  2. Scegli Crea metodo.

  3. In Tipo di metodo, seleziona GET.

  4. Per Tipo di integrazione, seleziona integrazione. HTTP

  5. Mantieni disattivata l'integrazione del HTTP proxy.

  6. Per HTTPmetodo, seleziona GET.

  7. Per Endpoint URL, immetterehttp://petstore-demo-endpoint.execute-api.com/petstore/pets.

    Il PetStore sito Web consente di recuperare un elenco di Pet elementi in base al tipo di animale domestico, ad esempio «Cane» o «Gatto», in una determinata pagina.

  8. Per Gestione contenuti seleziona Transito.

  9. Scegli i parametri URL della stringa di interrogazione.

    Il PetStore sito Web utilizza i parametri type e della stringa di page query per accettare un input. Si aggiungono i parametri della stringa di query alla richiesta del metodo e li si mappa nei parametri della stringa di query corrispondenti della richiesta di integrazione.

  10. Per aggiungere i parametri della stringa di query, effettuate le seguenti operazioni:

    1. Scegliere Add query string (Aggiungi stringa di query).

    2. Per Nome immetti type.

    3. Mantieni Obbligatorio e Caching disattivati.

    Ripeti le fasi precedenti per creare una stringa di query aggiuntiva denominata page.

  11. Scegli Crea metodo.

Se invii una richiesta, ora il client può fornire un tipo di animale e un numero di pagina come parametri della stringa di query. Questi parametri di input devono essere mappati nei parametri della stringa di query dell'integrazione per inoltrare i valori di input al nostro PetStore sito Web nel backend.

Per mappare i parametri di input alla richiesta di integrazione

  1. Nella scheda Richiesta di integrazione scegli Modifica in Impostazioni della richiesta di integrazione.

  2. Scegliete i parametri della stringa di URL query, quindi effettuate le seguenti operazioni:

    1. Scegli Aggiungi parametro della stringa di query.

    2. Per Nome, immetti type.

    3. Per Mappato da immetti method.request.querystring.type.

    4. Mantieni disattivata l'opzione Caching.

    5. Scegli Aggiungi parametro della stringa di query.

    6. Per Nome, immetti page.

    7. Per Mappato da immetti method.request.querystring.page.

    8. Mantieni disattivata l'opzione Caching.

  3. Seleziona Salva.

Per testare il API

  1. Seleziona la scheda Test. Potrebbe essere necessario scegliere il pulsante freccia destra per visualizzare la scheda.

  2. In Stringhe di query immetti type=Dog&page=2.

  3. Scegli Test (Esegui test).

    Il risultato è simile al seguente:

    Risultato del metodo Test-invoke GET on pets

    Ora che il test ha avuto esito positivo, possiamo implementarlo API per renderlo disponibile al pubblico.

  4. Scegliere Deploy (Implementa)API.

  5. In Fase, seleziona Nuova fase.

  6. In Stage name (Nome fase) immettere Prod.

  7. (Facoltativo) In Description (Descrizione), immettere una descrizione.

  8. Seleziona Deploy (Implementa).

  9. (Facoltativo) In Dettagli dello stage, per Invoke URL, puoi scegliere l'icona di copia per copiare la tua API chiamata. URL Puoi usarla con strumenti come Postman e c URL per testare il tuo. API

Se usi an SDK per creare un client, puoi chiamare i metodi esposti da SDK per firmare la richiesta. Per i dettagli sull'implementazione, consulta quello AWS SDKdi tua scelta.

Nota

Quando vengono apportate modifiche alla tuaAPI, devi ridistribuirla API per rendere disponibili le funzionalità nuove o aggiornate prima di richiamare nuovamente la richiesta. URL

(Facoltativo) Mappatura dei parametri di richiesta

Mappa i parametri di richiesta per un gateway API API

Questo tutorial mostra come creare un parametro path di {petId} on the API method request per specificare un ID elemento, mapparlo al parametro {id} path nella richiesta URL di integrazione e inviare la richiesta all'endpoint. HTTP

Nota

Se immetti una lettera maiuscola o minuscola errata, ad esempio una lettera minuscola anziché maiuscola, verranno restituiti errori più avanti nella procedura dettagliata.

Fase 1: Creazione delle risorse

In questo passaggio, crei una risorsa con un parametro path {petId}.

Per creare la risorsa {petId}

  1. Seleziona la risorsa /pets, quindi scegli Crea risorsa.

  2. Mantieni l'opzione Risorsa proxy disattivata.

  3. Per Percorso risorsa seleziona /pets.

  4. Per Resource Name (Nome risorsa) immetti {petId}.

    Usa le parentesi graffe ({ }) in petId modo che /pets/ {} sia visualizzato. petId

  5. Mantieni CORS(Cross Origin Resource Sharing) disattivata.

  6. Scegli Crea risorsa.

Fase 2: Creazione e test dei metodi

In questa fase crei un metodo GET con un parametro di percorso {petId}.

Per impostare il GET metodo

  1. Seleziona la risorsa/{petId}, quindi scegli il metodo Create.

  2. In Tipo di metodo, seleziona GET.

  3. Per Tipo di integrazione, seleziona HTTPintegrazione.

  4. Mantieni disattivata l'integrazione del HTTP proxy.

  5. Per HTTPmetodo, seleziona GET.

  6. Per EndpointURL, immettere http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}

  7. Per Gestione contenuti seleziona Transito.

  8. Mantieni attivata l'opzione Timeout predefinito.

  9. Scegli Crea metodo.

Ora mappate il parametro {petId} path che avete appena creato al parametro {id} path nell'HTTPendpoint URL della richiesta di integrazione. L'HTTPendpoint URL era. http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}

Per mappare il parametro di percorso {petId}

  1. Nella scheda Richiesta di integrazione scegli Modifica in Impostazioni della richiesta di integrazione.

  2. Scegli i parametri URL del percorso.

  3. APIGateway crea un parametro di percorso per la richiesta di integrazione denominata petId, tuttavia questo parametro di percorso non è valido per l'HTTPendpoint URL impostato come integrazione di backend. L'HTTPendpoint utilizza {id} come parametro del percorso. Per Nome, elimina petIde inserisciid.

    In questo modo, verrà mappato il parametro di percorso petId della richiesta del metodo al parametro di percorso id della richiesta di integrazione.

  4. Seleziona Salva.

Quindi testa il metodo.

Test del metodo 

  1. Seleziona la scheda Test. Potrebbe essere necessario scegliere il pulsante freccia destra per visualizzare la scheda.

  2. In Percorso per petId, immettere4.

  3. Scegli Test (Esegui test).

    Se il test ha esito positivo, in Corpo della risposta viene visualizzato quanto segue:

    {
  "id": 4,
  "type": "bird",
  "price": 999.99
}

Fase 3: Implementare API

In questo passaggio, si distribuisce il in API modo da poter iniziare a chiamarlo al di fuori della console API Gateway.

Per distribuire API

  1. Scegliere Deploy (Implementa)API.

  2. Per Fase seleziona Produzione.

  3. (Facoltativo) In Description (Descrizione), immettere una descrizione.

  4. Seleziona Deploy (Implementa).

Fase 4: Test del API

In questo passaggio, esci dalla console API Gateway e utilizzi la tua API per accedere all'HTTPendpoint.

  1. Nel pannello di navigazione principale scegli Fase.

  2. Nella sezione Dettagli dello stage, scegli l'icona di copia per copiare API la tua chiamataURL.

    Dovrebbe essere simile a quanto segue:

    https://my-api-id.execute-api.region-id.amazonaws.com/prod

  3. URLInseriscila nella casella dell'indirizzo di una nuova scheda del browser e aggiungila URL prima di /pets/4 inviare la richiesta.

  4. Il browser restituirà quanto segue:

    {
  "id": 4,
  "type": "bird",
  "price": 999.99
}

Passaggi successivi

Puoi personalizzare ulteriormente la tua API attivando la convalida della richiesta, trasformando i dati o creando risposte gateway personalizzate.

Per scoprire altri modi per personalizzare il tuoAPI, consulta i seguenti tutorial: