Questa pagina si applica a Apigee e Apigee ibridi.
Visualizza documentazione di Apigee Edge.
Cosa imparerai a fare
In questo tutorial imparerai a:
- Creare un proxy API Apigee da una specifica OpenAPI.
- Chiama il proxy API utilizzando cURL.
- Aggiungi un criterio a un flusso condizionale.
- Testa la chiamata 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'iniziativa Open API (OAI) è incentrata su Creare, sviluppare e promuovere un formato di descrizione dell'API indipendente dal fornitore basato sul modello Swagger specifica." Per ulteriori informazioni sull'iniziativa OpenAPI, 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 facili da leggere e comprendere per gli esseri umani. La specifica descrive tali elementi API come percorso di base, percorsi e verbi, intestazioni, parametri di ricerca, operazioni, tipi di contenuti, 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 di destinazione fittizio di Apigee utilizzato in questo tutorial è ospitato su Apigee e restituisce semplici dati. Non richiede chiavi API o token di accesso. Infatti, puoi accedervi da un sito web del browser. Provalo facendo clic di seguito:
Il servizio di destinazione restituisce il saluto Hello, guest!
Per informazioni sul set completo di API supportate dal servizio di destinazione fittizio, consulta API di esempio Apigee
Che cosa ti serve
- Prima di iniziare, devi completare i passaggi in Panoramica e prerequisiti.
- Una specifica OpenAPI. In questo tutorial, utilizzerai
mocktarget.yaml
Specifica OpenAPI che descrive il target fittizio di Apigee serviziohttp://mocktarget.apigee.net
. Per ulteriori informazioni, vedi apigee/api-platform-samples. - cURL installato sulla tua macchina per effettuare chiamate API dalla riga di comando; o da un browser web.
Crea il proxy API
Per creare il proxy API da una specifica OpenAPI:
Se utilizzi la UI 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.
- Fai clic su Proxy API nella finestra principale.
In alternativa, puoi selezionare Sviluppo > Proxy API nella barra di navigazione a sinistra.
Fai clic su Crea nuovo.
-
Nella procedura guidata Crea proxy, fai clic su Utilizza specifiche OpenAPI per il modello Inverti proxy (più comune).
- Fai clic su URL e inserisci le seguenti informazioni:
URL 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
- 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 il parametro Specifica OpenAPI:
Campo Descrizione Predefinito Nome Nome del proxy API. Ad esempio: Mock-Target-API
.Proprietà title
della specifica OpenAPI con spazi sostituiti per trattiniPercorso base Componente del percorso che identifica in modo univoco questo proxy API all'interno dell'organizzazione. L'URL visibile al pubblico di questo proxy API è composto dal tuo indirizzo IP esterno o interno nome di dominio e questo percorso di base. Ad esempio: http://apitest.acme.com/mock-target-api
Contenuti del campo Nome convertiti in lettere minuscole Descrizione Descrizione del proxy API. description
della specifica OpenAPITarget (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 OpenAPIDi 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 ...
- Nella pagina Dettagli del proxy, modifica il campo Descrizione come segue:
API proxy for the Apigee mock target service endpoint.
- Fai clic su Avanti.
- Nella pagina Criteri comuni, in Sicurezza: autorizzazione assicurati che L'opzione Passthrough (nessuna autorizzazione) è selezionata e fai clic su Avanti:
- Nella pagina Flows, assicurati che tutte le operazioni siano selezionate.
- Fai clic su Avanti.
- Nella pagina Riepilogo, assicurati che un ambiente sia
in Deployment facoltativo e fai clic su Crea e
deployment:
Apigee crea il tuo nuovo proxy API e ne esegue il deployment nel tuo ambiente:
- Fai clic su Modifica proxy per visualizzare la pagina Panoramica per il proxy API.
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!
Aggiungi un criterio da XML a JSON
In seguito, aggiungerai il criterio da XML a JSON alla sezione Visualizza risposta XML. condizionale generato automaticamente al momento della creazione del proxy API dal specifica OpenAPI. Il criterio convertirà la risposta XML della destinazione in un file JSON la risposta corretta.
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 il
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
Trova 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>
Facciamo qualcosa che converta la risposta XML in JSON. Aggiungi il criterio da XML a JSON al flusso condizionale Visualizza risposta XML nel proxy API.
Nuovo editor proxy
Fai clic sulla scheda Sviluppo nella pagina Panoramica dell'API Mock-Target nella UI di Apigee.
- Nel riquadro a sinistra, in Proxy Endpoints > predefinita, fai clic sul pulsante Visualizza Flusso condizionale della risposta XML.
- Nel riquadro a sinistra, fai clic sul pulsante + nella riga Norme.
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.
- Fai clic su Crea per creare il criterio.
Fai clic sul pulsante + accanto al flusso Visualizza risposta XML nel Risposta.
- Nella finestra di dialogo Aggiungi passaggio criterio, fai clic su Seleziona criterio esistente. e seleziona XML to JSON-1.
Fai clic su Aggiungi. Il criterio da XML a JSON viene applicato alla risposta.
Per visualizzare il codice del flusso condizionale Visualizza risposta XML, fai clic su Passa all'editor di codice.
- Fai clic su Salva.
Editor proxy classico
Fai clic sulla scheda Sviluppo nella pagina Panoramica dell'API Mock-Target nella UI di Apigee.
Nel riquadro di navigazione a sinistra, in Endpoint proxy > predefinita, fai clic sul pulsante Visualizza Flusso condizionale della risposta XML.
Fai clic sul pulsante +Passaggio in basso, corrispondente al Risposta del flusso.
La finestra di dialogo Aggiungi passaggio si apre per mostrare un elenco categorizzato di tutti i criteri che puoi aggiungere.
Scorri fino alla categoria Mediazione e seleziona XML in JSON.
- Mantieni i valori predefiniti per Nome visualizzato e Nome.
Fai clic su Aggiungi. Il criterio da XML a JSON viene applicato alla risposta.
- Fai clic su Salva.
Ora che hai aggiunto il criterio, richiama di nuovo l'API utilizzando cURL. Nota che stai ancora
chiamando la stessa risorsa /xml
. Il servizio di destinazione restituisce comunque il proprio blocco
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"}}