Passaggio 6: pubblicazione di un'API

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

In questo passaggio, pubblicherai un'API sul 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 sul tuo portale

Passaggio 1: crea una specifica OpenAPI

Ogni specifica OpenAPI funge da fonte attendibile per tutto il ciclo di vita delle 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 Sviluppo > Specifiche nella barra di navigazione a sinistra per aprire la pagina Specifiche.
2. Fai clic su + Specifiche > URL di importazione.
3. Inserisci le seguenti informazioni nella finestra di dialogo di importazione:
4. Nome 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 descriva l'API.

Per creare un proxy API da una specifica OpenAPI:

1. Nella pagina Specifiche, posiziona il cursore sulla 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. Tocca Avanti.

5. Nella pagina Norme:

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

   

6. Tocca Avanti.

7. Nella pagina Flussi, assicurati che tutte le operazioni siano selezionate e fai clic su Avanti.
   

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, vedrai una conferma che il nuovo proxy API è stato creato correttamente e ne è 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 consumatori dell'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 sul portale.
   

   Campo	Valore
   Nome	Ciao mondo
   Nome visualizzato	Ciao mondo
   Descrizione	Esempio semplice di Hello World
   Ambiente	Seleziona l'ambiente in cui viene eseguito il deployment del proxy API.
   Accesso	Pubblico
   Approva automaticamente le richieste di accesso	Abilitata
   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 Proxy API (se non è già selezionato) e seleziona API di destinazione simulata nell'elenco.
6. Fai clic su Aggiungi.
7. Fai clic su Salva per salvare il prodotto API.

   

Passaggio 4: pubblica l'API sul portale

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

Per pubblicare l'API sul tuo portale:

1. Vai alla pagina delle API nel tuo portale:
   1. Seleziona Pubblica > Portali nella barra di navigazione a sinistra.
   2. Fai clic sulla riga My first portal (Il mio primo portale) per aprire il portale.
   3. Fai clic su Catalogo API per visualizzare la pagina delle 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 sul tuo portale.
   • Per Immagine di copertina:
     1. Fai clic su Seleziona immagine.
     2. Fai clic su home-background.jpg dall'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.

   Per tutti gli altri valori, lascia le impostazioni predefinite.

5. Nella documentazione dell'API, puoi 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.

   

Per visualizzare la documentazione di riferimento dell'API:

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

---

Congratulazioni! Hai completato il tutorial. Vuoi saperne di più? Vai a Crea il tuo portale integrato.