Passaggio 6: pubblicazione di un'API

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

In questo passaggio, pubblicherai un'API nel portale seguendo questi passaggi:

  1. Creare un proxy API da una specifica
  2. Crea un prodotto API
  3. Pubblica l'API nel tuo portale

Passaggio 1: crea un proxy API da una specifica

Crea un proxy API da una specifica OpenAPI che descrive l'API.

Per creare un proxy API da una specifica OpenAPI:

  1. Nell'interfaccia utente di Apigee, seleziona Sviluppa > Proxy API nella barra di navigazione a sinistra per aprire la pagina Proxy API.
  2. Fai clic su Crea nuova.
    Aggiungi proxy API

    Viene visualizzata la procedura guidata Crea proxy che ti chiede di selezionare il tipo di proxy API da creare.

  3. In Proxy inverso (il più comune), fai clic su Utilizza la specifica OpenAPI. Utilizzare la specifica OpenAPI

    Viene visualizzata la finestra di dialogo Utilizza la specifica OpenAPI.

  4. Copia e incolla il seguente URL nel campo URL specifica OpenAPI della scheda URL:

    https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
  5. Fai clic su Seleziona.
    Si apre la procedura guidata Crea proxy e la pagina Dettagli proxy viene precompilata utilizzando i valori della specifica OpenAPI.

    Pagina dei dettagli del proxy nella procedura guidata Crea proxy, precompilata con i contenuti

  6. Modifica il campo Descrizione come segue: Proxy API per Hello World.

  7. Fai clic su Avanti.

  8. Nella pagina Norme:

    • In Sicurezza: autorizzazione, seleziona Passa (nessuna autorizzazione).
    • In Sicurezza: browser, seleziona Aggiungi intestazioni CORS .

    Pagina Norme comuni nella procedura guidata Crea proxy con le opzioni Trasferisci e Aggiungi intestazioni CORS selezionate

  9. Fai clic su Avanti.

  10. Nella pagina Fluidi, assicurati che tutte le operazioni siano selezionate e fai clic su Avanti.
    Creare flussi proxy

  11. Nella pagina Riepilogo, seleziona l'ambiente in cui vuoi eseguire il deployment in Deployment facoltativo.

  12. Fai clic su Crea ed esegui il deployment.

Nella pagina Riepilogo, vedrai un messaggio di conferma che indica che il nuovo proxy API è stato creato correttamente e disegnato nell'ambiente selezionato.


Passaggio 2: crea un prodotto API

Crea un prodotto API contenente le risorse API che vuoi esporre ai tuoi consumatori di API.

Per creare un prodotto API:

  1. Nell'interfaccia utente di Apigee, seleziona Pubblica > Prodotti API nella barra di navigazione a sinistra per aprire la pagina Prodotti API.
  2. Fai clic su +CREA.
    Viene visualizzata la pagina Prodotto.
  3. Inserisci i dettagli del prodotto per il prodotto API.
    Nota: per impostazione predefinita, i campi Nome visualizzato e Descrizione vengono visualizzati nel portale quando pubblichi il prodotto API. Puoi modificare i valori nel passaggio 3: pubblica l'API nel tuo portale.
    Campo Valore
    Nome Hello World
    Nome visualizzato Hello World
    Descrizione Esempio semplice di ciao mondo
    Ambiente Seleziona l'ambiente in cui è stato eseguito il deployment del proxy API.
    Accesso Pubblica
    Approvare automaticamente le richieste di accesso Abilitata
    Quota (Lasciare vuoto)
    Ambiti OAuth consentiti (Lasciare vuoto)
  4. Nella sezione Operazioni, fai clic su AGGIUNGI UN'OPERAZIONE per identificare le operazioni da aggiungere al prodotto API.
  5. In Origine, fai clic su Proxy API e seleziona Mock-Target-API dal menu a discesa.
  6. In Operazione, inserisci una barra (/) nel campo Percorso. Ignora gli altri campi.
  7. Fai clic su Salva per salvare l'operazione.
  8. Viene visualizzata la finestra di dialogo Aggiungi operazione. Aggiungi il proxy API Mock-Target-API nella finestra di dialogo Aggiungi operazione
  9. Fai clic su Aggiungi.
  10. Fai clic su Salva.

Passaggio 3: pubblica l'API nel tuo portale

Pubblica l'API nel tuo portale per consentire ai clienti di conoscerla e utilizzarla.

Per pubblicare l'API nel tuo portale:

  1. Nell'interfaccia utente di Apigee, vai alla pagina API nel tuo portale:
    1. Seleziona Pubblica > Portali nella barra di navigazione a sinistra.
    2. Fai clic sulla riga Il mio primo portale per aprirlo.
    3. Fai clic su Catalogo API per visualizzare la pagina API.
  2. Fai clic su +.
  3. Seleziona Hello World nella finestra di dialogo Aggiungi un prodotto API al catalogo e fai clic su Avanti.
  4. In Dettagli API, configura le seguenti opzioni:
    • Seleziona Pubblicata (elencata nel catalogo) per pubblicare l'API nel tuo portale.
    • Per Immagine di visualizzazione:
      1. Fai clic su Seleziona immagine.
      2. Fai clic su home-background.jpg nell'elenco delle immagini esistenti nella finestra di dialogo Seleziona immagine.
      3. Fai clic su Seleziona.
      4. Visualizza l'anteprima dell'immagine e fai clic su Seleziona.
    • In Categorie, inserisci Inizia e premi Invio.

    Lascia gli altri valori impostati sui valori predefiniti.

    Sezione dei dettagli dell'API quando aggiungi un'API al portale

  5. In Documentazione API, per generare automaticamente la documentazione di riferimento dell'API da uno snapshot della specifica OpenAPI:
    1. Seleziona Documento OpenAPI.
    2. Fai clic su Seleziona documento.
    3. Seleziona la scheda Importa da un URL.
    4. Inserisci helloworld nel campo Nome spec.
    5. Copia e incolla il seguente URL nel campo URL e premi Invio:
      https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
    6. Fai clic su Seleziona.

    Sezione della documentazione dell'API quando aggiungi un'API al portale

  6. Fai clic su Salva.

Per visualizzare la documentazione di riferimento dell'API:

  1. Nell'interfaccia utente di Apigee, fai clic su Portale in produzione per visualizzare le modifiche nel portale in produzione (o aggiorna il portale in produzione se è già aperto in un'altra scheda).
  2. Nel portale in tempo reale:
    a. Fai clic su API nella barra di navigazione in alto per visualizzare l'API pubblicata.
    b. Fai clic sulla scheda Hello World per visualizzare la documentazione di riferimento dell'API.
    c. Prova la tua API.

API target simulata pubblicata con il riquadro Prova questa API