Creazione di un proxy API da una specifica OpenAPI

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza documentazione di Apigee Edge.

Cosa imparerai a fare

In questo tutorial imparerai a:

• Crea un proxy API Apigee da una specifica OpenAPI.
• Chiama il proxy API utilizzando cURL.
• Aggiungi un criterio a un flusso condizionale.
• Testa l'invocazione del criterio utilizzando cURL.

Imparerai come creare un proxy API Apigee da un'API OpenAPI Specifica mediante la UI di Apigee. Quando chiami il proxy API con un Client HTTP, come cURL, il proxy API invia la richiesta al target fittizio di Apigee completamente gestito di Google Cloud.

Informazioni sull'iniziativa Open API

"L'Open API Initiative (OAI) si concentra sulla creazione, sull'evoluzione e sulla promozione di un formato di descrizione dell'API indipendente dal fornitore basato sulla specifica Swagger." Per ulteriori informazioni sull'iniziativa Open API, consulta la specifica OpenAPI.

Una specifica OpenAPI utilizza un formato standard per descrivere un'API RESTful. Scritta in formato JSON o YAML, una specifica OpenAPI è leggibile dalle macchine, ma anche per gli esseri umani. La specifica descrive elementi di un'API come il percorso di base, i percorsi e i verbi, le intestazioni, i parametri di query, le operazioni, i tipi di contenuti, le descrizioni delle risposte e altro ancora. Inoltre, una specifica OpenAPI viene comunemente utilizzata per generare la documentazione dell'API.

Informazioni sul servizio di destinazione simulato Apigee

Il servizio target simulato Apigee utilizzato in questo tutorial è ospitato in Apigee e restituisce dati semplici. Non richiede una chiave API o un token di accesso. Infatti, puoi accedervi in un browser web. Prova a fare clic su quanto segue:

http://mocktarget.apigee.net

Il servizio di destinazione restituisce il saluto Hello, guest!

Per informazioni sull'insieme completo di API supportate dal servizio target simulato, consulta API di esempio Apigee

Che cosa ti serve

• Prima di iniziare, devi completare i passaggi descritti in Panoramica e prerequisiti.
• Una specifica OpenAPI. In questo tutorial, utilizzerai mocktarget.yaml Specifica OpenAPI che descrive il target fittizio di Apigee servizio http://mocktarget.apigee.net. Per ulteriori informazioni, consulta apigee/api-platform-samples.
• cURL installato sulla tua macchina per effettuare chiamate API dalla riga di comando oppure un browser web.

Crea il proxy API

Per creare il proxy API da una specifica OpenAPI:

1. Se utilizzi l'interfaccia utente di Apigee nella console Cloud: seleziona Sviluppo proxy > Proxy API.

   Se utilizzi la UI di Apigee classica: seleziona Sviluppa > Proxy API e, nel riquadro Proxy, seleziona l'ambiente per il proxy.

2. Fai clic su Proxy API nella finestra principale.

   In alternativa, puoi selezionare Sviluppa > Proxy API nella barra di navigazione a sinistra.

   

3. Fai clic su Crea nuovo.

   

4. Nella procedura guidata Crea proxy, fai clic su Utilizza specifiche OpenAPI per il modello Inverti proxy (più comune).

   
5. Fai clic su URL e inserisci le seguenti informazioni:

   URL della specifica OpenAPI: percorso dei contenuti non elaborati su GitHub per la specifica OpenAPI nel campo URL:

   https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml

6. Fai clic su Seleziona.

   Viene visualizzata la pagina Dettagli proxy nella procedura guidata Crea proxy. I campi vengono precompilati utilizzando i valori definiti nella specifica OpenAPI, come mostrato in figura che segue:

   

   La tabella seguente descrive i valori predefiniti precompilati utilizzando la specifica OpenAPI:

   Campo	Descrizione	Predefinito
   Nome	Nome del proxy API. Ad esempio: Mock-Target-API.	Proprietà title della specifica OpenAPI con gli spazi sostituiti da trattini
   Percorso di base	Componente del percorso che identifica in modo univoco questo proxy API all'interno dell'organizzazione. L'URL pubblico di questo proxy API è costituito dal nome di dominio interno o esterno e da questo percorso di base. Ad esempio: http://apitest.acme.com/mock-target-api	I contenuti del campo Nome convertiti in minuscolo
   Descrizione	Descrizione del proxy API.	Proprietà description della specifica OpenAPI
   Target (API esistente)	URL di destinazione richiamato per conto di questo proxy API. Qualsiasi URL accessibile tramite è possibile usare internet. Ad esempio: http://mocktarget.apigee.net	servers della specifica OpenAPI

   Di seguito viene fornito un estratto della specifica OpenAPI che mostra utilizzate per precompilare i campi.

   openapi: 3.0.0
   info:
     description: OpenAPI Specification for the Apigee mock target service endpoint.
     version: 1.0.0
     title: Mock Target API
   paths:
     /:
       get:
         summary: View personalized greeting
         operationId: View a personalized greeting
         description: View a personalized greeting for the specified or guest user.
         parameters:
           - name: user
             in: query
             description: Your user name.
             required: false
             schema:
               type: string
         responses:
           "200":
             description: Success
   ...
   servers:
     - url: http://mocktarget.apigee.net
     - url: https://mocktarget.apigee.net
   ...
   

7. Nella pagina Dettagli del proxy, modifica il campo Descrizione come segue:

   API proxy for the Apigee mock target service endpoint.

8. Fai clic su Avanti.
9. Nella pagina Criteri comuni, in Sicurezza: autorizzazione assicurati che L'opzione Passthrough (nessuna autorizzazione) è selezionata e fai clic su Avanti:

   

10. Nella pagina Flows, assicurati che tutte le operazioni siano selezionate.
    Suggerimento: i flussi condizionali vengono generati automaticamente dalle operazioni definite all'interno dell'oggetto paths nella specifica OpenAPI. I flussi condizionali dicono ad Apigee: "Quando vedi questo, esegui questa logica". Ad esempio, quando una chiamata API è GET sulla risorsa /xml (la condizione), trasforma la risposta in JSON (tramite un criterio collegato flusso condizionale). Viene eseguito un solo flusso per transazione, ovvero il primo flusso la cui condizione è valutata come true.
    
11. Fai clic su Avanti.
12. Nella pagina Riepilogo, assicurati che sia selezionato un ambiente in Deployment facoltativo e fai clic su Crea ed esegui il deployment:

    

    Apigee crea il tuo nuovo proxy API e ne esegue il deployment nel tuo ambiente:

13. Fai clic su Modifica proxy per visualizzare la pagina Panoramica del proxy API.

Congratulazioni! Hai creato un proxy API da una specifica OpenAPI. Adesso devi testarlo per vedere come funziona.

Testa il proxy API

Puoi testare l'API Mock-Target-API utilizzando cURL o un browser web.

curl -v YOUR_ENV_GROUP_HOSTNAME/myproxy

dove YOUR_ENV_GROUP_HOSTNAME è il nome host del gruppo di ambienti. Consulta: Trova il nome host del gruppo di ambienti.

Ad esempio:

curl -v -k https://apitest.acme.com/myproxy

Risposta

Dovresti vedere la seguente risposta:

Hello, Guest!

Complimenti! Hai creato un semplice proxy API partendo da una specifica OpenAPI e testato li.

Aggiungere un criterio XML to JSON

A questo punto, aggiungi il criterio XML to JSON al flusso condizionale Visualizza risposta XML generato automaticamente quando hai creato il proxy API dalla specifica OpenAPI. Il criterio convertirà la risposta XML del target in una risposta JSON.

Innanzitutto, chiama l'API in modo da poter confrontare i risultati con quelli ricevuti dopo aver aggiunto il criterio. In una finestra del terminale, esegui il seguente comando cURL. Stai chiamando la risorsa /xml del servizio di destinazione, che restituisce in modo nativo un semplice blocco di XML.

curl -v https://YOUR_ENV_GROUP_HOSTNAME/mock-target-api/xml

dove YOUR ENV_GROUP_HOSTNAME è il nome host del gruppo di ambienti. Consulta Trovare il nome host del gruppo di ambienti.

Risposta

Dovresti vedere la seguente risposta:

<root> 
  <city>San Jose</city> 
  <firstName>John</firstName> 
  <lastName>Doe</lastName> 
  <state>CA</state> 
</root>

Ora facciamo qualcosa che converta la risposta XML in JSON. Aggiungi il criterio XML to JSON al flusso condizionale Visualizza risposta XML nel proxy API.

Nota: Apigee sta introducendo una nuova versione dell'editor di proxy che semplifica la gestione dei proxy.

Le istruzioni nelle prime due schede riportate di seguito spiegano come utilizzare il nuovo editor proxy o quello classico.

Nuovo editor proxy

1. Fai clic sulla scheda Sviluppa nella pagina Panoramica API di destinazione simulata nell'interfaccia utente di Apigee.



2. Nel riquadro a sinistra, fai clic sul flusso condizionale Visualizza risposta XML in Endpoint proxy > predefinito.
3. Nel riquadro a sinistra, fai clic sul pulsante + nella riga Norme.

4. Nella finestra di dialogo Crea criterio, fai clic nel campo Seleziona il tipo di criterio, scorri verso il basso fino a Mediazione e seleziona XMLToJSON. Mantieni i valori predefiniti per Nome visualizzato e Nome.

5. Fai clic su Crea per creare il criterio.

6. Fai clic sul pulsante + accanto al flusso Visualizza risposta XML in Risposta.

   

7. Nella finestra di dialogo Aggiungi passaggio criterio, fai clic su Seleziona criterio esistente. e seleziona XML to JSON-1.

8. Fai clic su Aggiungi. Il criterio XML to JSON viene applicato alla risposta.

   

   Per visualizzare il codice del flusso condizionale Visualizza risposta XML, fai clic su Passa all'editor di codice.

9. Fai clic su Salva.

Editor proxy classico

1. Fai clic sulla scheda Sviluppa nella pagina Panoramica API di destinazione simulata nell'interfaccia utente di Apigee.

   

2. Nel riquadro del navigatore a sinistra, fai clic sul flusso condizionale Visualizza risposta XML in Endpoint proxy > predefinito.

   

3. Fai clic sul pulsante +Passaggio in basso, corrispondente al Risposta del flusso.

   

   Viene visualizzata la finestra di dialogo Aggiungi passaggio, che mostra un elenco classificato di tutti i criteri che puoi aggiungere.

4. Scorri fino alla categoria Mediazione e seleziona XML in JSON.

   
5. Mantieni i valori predefiniti per Nome visualizzato e Nome.

6. Fai clic su Aggiungi. Il criterio da XML a JSON viene applicato alla risposta.

   
7. Fai clic su Salva.

Ora che hai aggiunto il criterio, richiama di nuovo l'API utilizzando cURL. Tieni presente che stai ancora chiamando la stessa risorsa /xml. Il servizio di destinazione restituisce ancora il proprio blocco di XML, ma ora il criterio nel proxy API convertirà la risposta in JSON. Crea chiama:

curl -v https://YOUR_ENV_GROUP_HOSTNAME/mock-target-api/xml

dove YOUR ENV_GROUP_HOSTNAME è il nome host del gruppo di ambienti. Consulta: Trova il nome host del gruppo di ambienti.

Tieni presente che la risposta XML viene convertita in JSON:

{"root":{"city":"San Jose","firstName":"John","lastName":"Doe","state":"CA"}}

Congratulazioni! Hai testato l'esecuzione di una norma aggiunta a un condizionale.