Pubblica le tue API (versione originale)

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

Pubblica le API sul tuo portale per renderle disponibili per l'uso da parte degli sviluppatori di app, come descritto nelle sezioni seguenti.

Panoramica della pubblicazione dell'API

La procedura di pubblicazione delle API sul portale prevede due passaggi:

1. Seleziona il prodotto API che vuoi pubblicare sul tuo portale.
2. Genera automaticamente la documentazione di riferimento delle API da uno snapshot della specifica OpenAPI per consentire agli sviluppatori di app di acquisire informazioni sulle tue API. Per ulteriori informazioni sugli snapshot, consulta Che cos'è uno snapshot di una specifica OpenAPI?

Quando pubblichi un'API sul tuo portale, al portale vengono apportati automaticamente i seguenti aggiornamenti:

• Una pagina di riferimento API viene aggiunta al portale
  La pagina di riferimento API mostra la documentazione di riferimento API che generi automaticamente da uno snapshot della specifica OpenAPI. Gli sviluppatori possono esaminare la documentazione dell'API e fare clic su Prova per effettuare una richiesta API e visualizzare l'output.

  Nota: non puoi modificare direttamente i contenuti di questa pagina perché non viene visualizzata nell'elenco di pagine del tuo portale.

  

• Viene aggiunto un link alla pagina di riferimento delle API
  La pagina delle API (inclusa nel portale di esempio) fornisce un elenco di tutte le API pubblicate sul tuo portale con link alla rispettiva documentazione di riferimento per ulteriori informazioni.

  Nota: non puoi modificare direttamente i contenuti di questa pagina perché non viene visualizzata nell'elenco di pagine del tuo portale.

  

Che cos'è uno snapshot di una specifica OpenAPI?

Ogni specifica OpenAPI funge da fonte attendibile per tutto il ciclo di vita di un'API. La stessa specifica viene utilizzata in ogni fase del ciclo di vita dell'API, dallo sviluppo alla pubblicazione fino al monitoraggio. Quando modifichi una specifica, devi essere a conoscenza dell'impatto delle modifiche sull'API in altre fasi del ciclo di vita, come descritto in Cosa succede se modifico una specifica?

Quando pubblichi l'API, acquisisci uno snapshot della specifica OpenAPI per generare la documentazione di riferimento dell'API. Lo snapshot rappresenta una versione specifica della specifica nell'archivio delle specifiche. Se modifichi la specifica OpenAPI utilizzando l'editor delle specifiche, puoi decidere di acquisire un'altra istantanea della specifica per riflettere le ultime modifiche apportate alla documentazione di riferimento dell'API.

Aggiunta del supporto CORS ai proxy API

Prima di pubblicare le API, devi aggiungere il supporto CORS ai proxy API per supportare le richieste multiorigine lato client.

CORS (Cross-Origin Resource Sharing) è un meccanismo standard che consente alle chiamate XMLHttpRequest (XHR) di JavaScript eseguite in una pagina web di interagire con le risorse dei domini non di origine. CORS è una soluzione comunemente implementata per il criterio della stessa origine applicato da tutti i browser. Ad esempio, se effettui una chiamata XHR all'API Twitter dal codice JavaScript in esecuzione nel browser, la chiamata avrà esito negativo. Questo perché il dominio che pubblica la pagina nel tuo browser non è lo stesso che fornisce l'API di Twitter. CORS offre una soluzione a questo problema consentendo ai server di eseguire l'attivazione se vogliono fornire la condivisione delle risorse tra origini.

Per informazioni sull'aggiunta del supporto CORS ai proxy API prima di pubblicare le API, vedi Aggiungere il supporto CORS a un proxy API.

Nota: la maggior parte dei browser moderni applica CORS. Consulta l'elenco completo dei browser supportati. Per una descrizione approfondita di CORS, consulta il consiglio W3C per la condivisione delle risorse tra origini.

Esplora la pagina delle API

Per accedere alla pagina delle API:

1. Seleziona Pubblica > Portali e seleziona il tuo portale.
2. Fai clic su API nella home page del portale.

In alternativa, puoi selezionare API dal menu a discesa del portale nella barra di navigazione in alto.

Viene visualizzato l'elenco delle API.

Come evidenziato nella figura precedente, la pagina delle API consente di:

• Visualizza i dettagli delle API disponibili nel tuo portale
• Aggiungi un'API al portale
• Acquisisci uno snapshot della specifica OpenAPI associata a un prodotto API per aggiornare la documentazione di riferimento dell'API
• Pubblicare o annullare la pubblicazione di un'API sul portale
• Gestire il pubblico per un'API sul portale
• Modificare la specifica associata (vedi Creare specifiche utilizzando l'editor delle specifiche).
• Rimuovere un'API dal portale
• Identifica rapidamente le API "orfane" il cui prodotto API associato è stato rimosso da Edge e ricrea il prodotto API o elimina l'API dal tuo portale

Aggiungi un'API al portale

Nota: puoi aggiungere un massimo di 100 API al tuo portale.

Per aggiungere un'API al tuo portale:

1. Seleziona Pubblica > Portali e seleziona il tuo portale.
2. Fai clic su API nella home page del portale.
   In alternativa, puoi selezionare API nel menu a discesa del portale nella barra di navigazione in alto.
3. Fai clic su + API.
   Viene visualizzata la finestra di dialogo Aggiungi prodotto API al portale.

4. Nella scheda Prodotto API della finestra di dialogo, seleziona il prodotto API che vuoi aggiungere al tuo portale.
   

5. Tocca Avanti.

6. Seleziona l'origine da utilizzare per lo snapshot.
   Se hai creato il proxy API incluso nel prodotto API utilizzando una specifica OpenAPI, seleziona la specifica dall'elenco a discesa.
   

   In alternativa, puoi selezionare:

   • Nessuna specifica e aggiungine una in un secondo momento dopo la pubblicazione dell'API, come descritto in Acquisizione di uno snapshot della specifica.
   • Scegli una specifica diversa per selezionarne o caricarne una nuova.

7. Seleziona la casella di controllo Pubblicata per pubblicare l'API sul tuo portale. Deseleziona Pubblicata se non vuoi pubblicare l'API.
   Puoi modificare l'impostazione in un secondo momento, come descritto in Pubblicare o annullare la pubblicazione di un'API sul portale.

8. In Pubblico, seleziona una delle seguenti opzioni per gestire il pubblico per la tua API consentendo l'accesso a:

   • Utenti anonimi per consentire a tutti gli utenti di visualizzare la pagina.
   • Utenti registrati per consentire la visualizzazione della pagina solo agli utenti registrati.

   Puoi modificare l'impostazione in un secondo momento, come descritto in Gestire il pubblico per un'API sul portale.

9. Fai clic su Fine.

Scatta un'istantanea della specifica

Dopo aver pubblicato l'API, puoi eseguire in qualsiasi momento un nuovo snapshot della specifica OpenAPI per aggiornare la documentazione di riferimento dell'API pubblicata sul tuo portale.

Per acquisire un'istantanea della specifica OpenAPI:

1. Seleziona Pubblica > Portali e seleziona il tuo portale.
2. Fai clic su API nella home page del portale.
   In alternativa, puoi selezionare API nel menu a discesa del portale nella barra di navigazione in alto.
3. Posiziona il cursore sull'API per la quale vuoi creare uno snapshot per visualizzare le azioni.

4. Fai clic su .

   Nota: viene visualizzato un messaggio se lo snapshot è attuale con la specifica di origine selezionata.

5. Seleziona una specifica esistente dal menu a discesa Sorgente istantanea o seleziona Scegli una specifica diversa per selezionare o caricare una nuova specifica da utilizzare per generare la documentazione per l'API. In alternativa, puoi selezionare Nessuna specifica per rimuovere la specifica corrente.

6. Fai clic su Aggiorna istantanea (o Rimuovi istantanea, se hai selezionato Nessuna specifica).

La documentazione di riferimento dell'API viene generata a partire dalla specifica e aggiunta alla pagina Riferimento API.

Pubblicare o annullare la pubblicazione di un'API sul portale

Per pubblicare un'API sul tuo portale o annullarne la pubblicazione:

1. Seleziona Pubblica > Portali e seleziona il tuo portale.
2. Fai clic su API nella home page del portale.
   In alternativa, puoi selezionare API nel menu a discesa del portale nella barra di navigazione in alto.
3. Posiziona il cursore sull'API per la quale vuoi pubblicare o annullare la pubblicazione.
4. Fai clic su .
5. Seleziona la casella di controllo Abilitata per pubblicare l'API sul tuo portale. Deseleziona Abilitata per annullare la pubblicazione dell'API.
6. Fai clic su Salva.

Gestisci il pubblico per un'API sul tuo portale

Gestisci il pubblico dell'API sul tuo portale consentendo l'accesso a:

• Tutti gli utenti
• Solo utenti registrati

Per gestire il pubblico per un'API sul tuo portale:

1. Seleziona Pubblica > Portali e seleziona il tuo portale.
2. Fai clic su API nella home page del portale.
   In alternativa, puoi selezionare API nel menu a discesa del portale nella barra di navigazione in alto.
3. Posiziona il cursore sull'API per la quale vuoi eseguire una gestione del segmento di pubblico per visualizzare le azioni.
4. Fai clic su .
5. In Pubblico, seleziona una delle seguenti opzioni:
   • Utenti anonimi per consentire a tutti gli utenti di visualizzare il prodotto API.
   • Utenti registrati per consentire solo agli utenti registrati di visualizzare il prodotto API.
6. Fai clic su Salva.

Rimuovere un'API dal portale

Per rimuovere un'API dal portale:

1. Seleziona Pubblica > Portali e seleziona il tuo portale.
2. Fai clic su API nella home page del portale.
   In alternativa, puoi selezionare API nel menu a discesa del portale nella barra di navigazione in alto.
3. Posiziona il cursore sull'API nell'elenco per visualizzare il menu delle azioni.
4. Fai clic su .

Risolvere i problemi relativi alle API pubblicate

Quando utilizzi la funzione Prova, se viene restituito l'errore TypeError: Failed to fetch, prendi in considerazione le seguenti possibili cause e soluzioni:

• In caso di errori di contenuti misti, l'errore potrebbe essere causato da un problema noto dell'interfaccia utente. Una possibile soluzione alternativa consiste nell'assicurarti di specificare HTTPS prima di HTTP nella definizione di schemes della specifica OpenAPI. Ad esempio:

   schemes:
     - https
     - http
  

• In caso di errori di limitazione relativi a CORS (Cross-Origin Resource Sharing), assicurati che CORS sia supportato per i proxy API. CORS è un meccanismo standard che consente le richieste multiorigine lato client. Vedi Aggiunta del supporto CORS per un proxy API. Assicurati che l'accesso CORS sia abilitato anche nel browser.