Creazione di un proxy API da una specifica OpenAPI

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la 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 una policy a un flusso condizionale.
Testa l'invocazione della policy utilizzando cURL.

Scoprirai come creare un proxy API Apigee da una specifica OpenAPI utilizzando l'interfaccia utente Apigee. Quando chiami il proxy API con un client HTTP, ad esempio cURL, il proxy API invia la richiesta al servizio di destinazione simulato Apigee.

Informazioni sull'iniziativa Open API

"L'Open API Initiative (OAI) si concentra sulla creazione, l'evoluzione e la promozione di un formato di descrizione API indipendente dal fornitore basato sulla specifica Swagger." Per saperne di più 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 dal computer, ma è anche facile da leggere e comprendere 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 ricerca, le operazioni, i tipi di contenuti, le descrizioni delle risposte e altro ancora. Inoltre, una specifica OpenAPI viene comunemente utilizzata per generare la documentazione API.

Informazioni sul servizio di destinazione simulato di Apigee

Il servizio di destinazione simulato di Apigee utilizzato in questo tutorial è ospitato su Apigee e restituisce dati semplici. Non richiede chiavi API o token di accesso. Infatti, puoi accedervi in un browser web. Per provarlo, fai clic su:

http://mocktarget.apigee.net

Il servizio di destinazione restituisce il saluto Hello, guest!

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

Che cosa ti serve

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

Crea il proxy API

Per creare il proxy API da una specifica OpenAPI:

Nella console Google Cloud , vai alla pagina Apigee > Sviluppo proxy > Proxy API.

Vai ai proxy API
Nel riquadro Proxy API, fai clic su + Crea.
Nel riquadro Crea un proxy, in Modello di proxy > Modello di specifiche OpenAPI, seleziona Proxy inverso (più comune).

Vai al seguente URL nel browser web:

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

Fai clic con il tasto destro del mouse sul codice visualizzato e seleziona Salva con nome.
Fai clic su Salva per salvare mocktarget3.0.yaml nella posizione desiderata.
Nel campo Specifiche OpenAPI, fai clic sul pulsante Sfoglia.
Vai al file mocktarget3.0.yaml e fai clic su Apri.
Fai clic su Avanti.
Il passaggio Dettagli proxy della procedura guidata Crea proxy compila automaticamente i campi con i valori estratti direttamente dalla specifica OpenAPI.

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

Campo	Descrizione	Predefinito
Nome proxy	Nome del proxy API. Ad esempio: `Mock-Target-API`.	Proprietà `title` della specifica OpenAPI con gli spazi sostituiti dai trattini
Base path	Componente del percorso che identifica in modo univoco questo proxy API all'interno dell'organizzazione. L'URL pubblico di questo proxy API è composto dal tuo nome di dominio esterno o interno e da questo percorso di base. Ad esempio: `http://apitest.acme.com/mock-target-api`	Contenuti del campo Nome convertiti in minuscolo
Descrizione	Descrizione del proxy API.	Proprietà `description` della specifica OpenAPI
Destinazione (API esistente)	URL di destinazione richiamato per conto di questo proxy API. È possibile utilizzare qualsiasi URL accessibile su internet aperto. Ad esempio: `http://mocktarget.apigee.net`	Proprietà `servers` della specifica OpenAPI

Di seguito è riportato un estratto della specifica OpenAPI che mostra le proprietà 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
      ...

Nel passaggio Dettagli proxy, modifica il campo Descrizione come segue:
```
API proxy for the Apigee mock target service endpoint.
```
Fai clic su Avanti.
Nel passaggio Flussi, 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 indicano ad Apigee: "Quando vedi questo, esegui questa logica". Ad esempio, quando una chiamata API è un GET sulla risorsa /xml (la condizione), trasforma la risposta in JSON (tramite un criterio collegato al flusso condizionale). Per ogni transazione viene eseguito un solo flusso, ovvero il primo la cui condizione restituisce il valore true.
Fai clic su Avanti.
Nel passaggio Esegui il deployment, seleziona uno o più ambienti e fai clic su Ok.
Fai clic su Crea.

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 è l'hostname del gruppo di ambienti. Vedi Trovare 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!

Aggiungere una norma XML to JSON

Successivamente, aggiungerai il criterio XML to JSON al flusso condizionale Visualizza risposta XML generato automaticamente quando hai creato il proxy API dalla specifica OpenAPI. La policy convertirà la risposta XML della destinazione in una risposta JSON.

Innanzitutto, chiama l'API in modo da poter confrontare i risultati con quelli ricevuti dopo aver aggiunto le norme. 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 è l'hostname 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.

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

Seleziona Visualizza risposta XML

Nel riquadro a sinistra, in Endpoint proxy > default, fai clic sul flusso condizionale Visualizza risposta XML.
Nel riquadro a sinistra, fai clic sul pulsante + nella riga Policy.
Nella finestra di dialogo Crea policy, fai clic sul campo Seleziona tipo di policy, 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 la policy.
Fai clic sul pulsante + accanto al flusso Visualizza risposta XML in Risposta.
Nella finestra di dialogo Aggiungi passaggio policy, fai clic sul campo Seleziona policy esistente e seleziona Da XML a JSON-1.
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.
Fai clic su Salva.

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

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