Passaggio 6: pubblicazione di un'API

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. info

In questo passaggio, pubblicherai un'API nel portale seguendo questi passaggi:
1. Crea una specifica OpenAPI
2. Crea un proxy API da una specifica
3. Crea un prodotto API
4. Pubblica l'API nel tuo portale

Passaggio 1: crea una specifica OpenAPI

Ogni specifica OpenAPI funge da fonte attendibile durante il ciclo di vita dell'API. La stessa specifica viene utilizzata in ogni fase del ciclo di vita dell'API, dallo sviluppo alla pubblicazione.

Per creare una specifica OpenAPI:

  1. Seleziona Sviluppa > Specifiche nella barra di navigazione a sinistra per aprire la pagina Specifiche.
  2. Fai clic su + Specifica > Importa URL.
  3. Nella finestra di dialogo di importazione, inserisci le seguenti informazioni:
  4. Nome dell'importazione: helloworld

  5. URL di importazione: https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

  6. Fai clic su Importa.

Passaggio 2: 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. Nella pagina Specifiche, posiziona il cursore sopra la specifica helloworld per visualizzare il menu delle azioni.
  2. Fai clic su per generare un proxy API dalla specifica.
    Viene aperta la procedura guidata Crea un proxy e la pagina Dettagli viene precompilata utilizzando i valori della specifica OpenAPI.
  3. Modifica il campo Descrizione come segue: Proxy API per Hello World.
  4. Fai clic su Avanti.

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

  6. Fai clic su Avanti.

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

  8. Nella pagina Host virtuali, assicurati che tutti gli host virtuali siano selezionati e fai clic su Avanti.

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

  10. Fai clic su Crea.

Nella pagina Riepilogo viene visualizzato un messaggio di conferma che indica che il nuovo proxy API è stato creato correttamente e di cui è stato eseguito il deployment nell'ambiente di test.

Passaggio 3: 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. Seleziona Pubblica > Prodotti API nella barra di navigazione a sinistra per aprire la pagina Prodotti API.
  2. Fai clic su + Prodotto API.
    Viene visualizzata la pagina Nuovo 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 4: 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 Attivato
    Quota (Lasciare vuoto)
    Ambiti OAuth consentiti (Lasciare vuoto)
  4. In Risorse API, fai clic su Aggiungi un proxy per identificare i proxy API da aggiungere al prodotto API.
    Viene visualizzata la finestra di dialogo Aggiungi risorsa API.
  5. Fai clic su API Proxy (se non è già selezionata) e seleziona Mock-Target-API nell'elenco.
  6. Fai clic su Aggiungi.
  7. Fai clic su Salva per salvare il prodotto API.

    Prodotto API Hello World che mostra tutti i campi impostati

Passaggio 4: 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. 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.

  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 Le mie specifiche (se non è già selezionata).
    4. Seleziona helloworld dall'elenco delle specifiche.
    5. Fai clic su Seleziona.
  6. Fai clic su Salva per salvare i dettagli dell'API.

    API Hello World che mostra tutti i campi impostati

Per visualizzare la documentazione di riferimento dell'API:

  1. Fai clic su Portale online per visualizzare le modifiche nel portale online (o aggiornalo se è già aperto in un'altra scheda).
  2. Fai clic su API nella barra di navigazione in alto per visualizzare l'API pubblicata.
  3. Fai clic sulla scheda Hello World per visualizzare la documentazione di riferimento dell'API. Prova la tua API.

API target simulata pubblicata con il riquadro Prova questa API

Complimenti! Hai completato il tutorial. Vuoi saperne di più? Vai a Creare il portale integrato.