Panoramica della pubblicazione

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Pubblicare è il processo che consente di rendere le API disponibili per l'utilizzo da parte degli sviluppatori di app per l'utilizzo.

Video: il seguente video fornisce un'introduzione di alto livello alla pubblicazione delle API

La pubblicazione delle API prevede le seguenti attività, descritte in questo argomento:

  1. Crea i prodotti API su Edge che raggruppano le tue API.
  2. Registra gli sviluppatori di app su Edge.
  3. Registra le app per sviluppatori su Edge.
  4. Fornisci documentazione e supporto della community per le tue API.

Attività 1: crea un prodotto API su Edge

La prima attività di pubblicazione consiste nel creare un prodotto API. Un prodotto API è una raccolta di risorse API offerte come pacchetto agli sviluppatori di app per l'utilizzo. Crea prodotti API utilizzando l'API di gestione o l'interfaccia utente di Edge. (Per saperne di più sui prodotti API , consulta Che cos'è un prodotto API?)

Un diagramma di sequenza da sinistra a destra che mostra uno sviluppatore, un'app, API e servizi di backend. L'icona e le risorse dell'API sono evidenziate. Una linea tratteggiata punta dallo sviluppatore a un'icona di un'app creata dallo sviluppatore. Le frecce che vanno e tornano all'app mostrano il flusso di richiesta e risposta a un'icona API, con una chiave dell'app posizionata sopra la richiesta. L'icona e le risorse dell'API sono evidenziate. Sotto l'icona dell'API si trovano due insiemi di percorsi delle risorse raggruppati in due prodotti API: prodotto Location e prodotto Media. Il prodotto Località dispone di risorse per /countries, /cities e /languages, mentre il prodotto Media dispone di risorse per /books, /magazines e /movies. A destra dell'API si trovano le risorse di backend chiamate dall'API, tra cui un database, un bus di servizio aziendale, server di app e un backend generico.

In questa figura, l'API è costituita da due prodotti, ognuno dei quali contiene tre risorse API.

In qualità di fornitore di API, hai la responsabilità di creare le API e i prodotti API per gestire il controllo dell'accesso, le limitazioni di utilizzo e qualsiasi altro requisito aziendale. Ad esempio, potresti:

  • Pubblicare un prodotto API senza costi che consenta l'accesso di sola lettura alle relative risorse API.
  • Pubblicare un secondo prodotto API a un prezzo basso che consenta l'accesso in lettura/scrittura alle stesse risorse API della versione senza costi, ma con un limite di accesso basso, ad esempio 1000 richieste al giorno.
  • Pubblicare un terzo prodotto API a un prezzo più elevato che consenta l'accesso in lettura/scrittura alla stessa API resource, ma con un limite di accesso elevato.

La cosa importante da ricordare è che Edge ti offre la flessibilità di creare prodotti API che soddisfino i requisiti aziendali delle tue API.

Per saperne di più sulla creazione di prodotti API, consulta Crea prodotti API.

Attività 2: registra uno sviluppatore di app su Edge

Uno sviluppatore crea le app che utilizzano le tue API. Uno sviluppatore di app si registra su Apigee Edge prima di poter registrare la propria app. Quando registra l'app, riceve una chiave API che gli darà accesso all'API.

Tramite il processo di registrazione dell'app, puoi controllare chi ha accesso alle tue API. In qualsiasi momento, puoi eliminare uno sviluppatore di app, invalidando tutte le chiavi API associate a questo sviluppatore, negandogli l'accesso alle tue API.

Un diagramma di sequenza da sinistra a destra che mostra uno sviluppatore, un'app, API e servizi di backend. L'icona sviluppatore è evidenziata. Una linea punteggiata punta dallo sviluppatore evidenziato a un'icona di un'app creata dallo sviluppatore. Le frecce che vanno e tornano all'app mostrano il flusso di richiesta e risposta a un'icona API, con una chiave dell'app posizionata sopra la richiesta. Sotto l'icona dell'API si trovano due insiemi di percorsi delle risorse raggruppati in due prodotti API: prodotto Location e prodotto Media. Il prodotto Località dispone di risorse per /countries, /cities e /languages, mentre il prodotto Media dispone di risorse per /books, /magazines e /movies. A destra dell'API si trovano le risorse di backend chiamate dall'API, tra cui un database, un bus di servizio aziendale, server di app e un backend generico.

In qualità di fornitore di API, decidi come registrare gli sviluppatori. Ad esempio, puoi utilizzare una procedura di registrazione manuale che richiede a un potenziale sviluppatore di contattare la tua organizzazione per registrarsi. Il potenziale sviluppatore deve fornire tutte le informazioni necessarie, come un indirizzo email, nome e cognome e nome dell'azienda. Se approvi la richiesta dello sviluppatore, puoi utilizzare l'interfaccia utente di gestione Edge per registrare manualmente lo sviluppatore. Per saperne di più, consulta Gestire gli sviluppatori di app per altro.

Apigee fornisce anche strumenti che puoi utilizzare per automatizzare la procedura di registrazione degli sviluppatori. Ad esempio:

  • Utilizza l'API di gestione Apigee Edge per integrare la funzionalità di registrazione nel tuo sito web esistente. L'API di gestione Edge è un'API REST che puoi utilizzare per eseguire tutti gli aspetti della procedura di registrazione degli sviluppatori. Per saperne di più, consulta Utilizzare l'API di gestione Edge per pubblicare le API.
  • Utilizza il portale Apigee Developer Services per registrare gli sviluppatori. Il portale supporta la registrazione degli sviluppatori, ma offre anche molte altre funzionalità per supportare le tue API. Per saperne di più, consulta Che cos'è un portale per sviluppatori?

Attività 3: registra un'app per sviluppatori su Edge

Prima che un'app possa accedere alle tue API, deve essere registrata su Edge. Tuttavia, solo uno sviluppatore registrato può registrare un'app su Edge.

Un diagramma di sequenza da sinistra a destra che mostra uno sviluppatore, un'app, API e servizi di backend. Le frecce dell'app, della richiesta/risposta e della chiave API sono evidenziate. Una linea tratteggiata punta dallo sviluppatore a un'icona di un'app creata dallo sviluppatore. Le frecce che vanno e tornano all'app mostrano il flusso di richiesta e risposta a un'icona API, con una chiave dell'app posizionata sopra la richiesta. L'icona e le risorse dell'API sono evidenziate. Sotto l'icona dell'API si trovano due insiemi di percorsi delle risorse raggruppati in due prodotti API: prodotto Location e prodotto Media. Il prodotto Località dispone di risorse per /countries, /cities e /languages, mentre il prodotto Media dispone di risorse per /books, /magazines e /movies. A destra dell'API si trovano le risorse di backend chiamate dall'API, tra cui un database, un bus di servizio aziendale, server di app e un backend generico.

Al momento della registrazione dell'app, lo sviluppatore seleziona uno o più prodotti API. Ad esempio, potresti pubblicare più prodotti API corrispondenti a diversi tipi di servizi e piani tariffari. Lo sviluppatore di app può quindi scegliere dall'elenco dei prodotti API disponibili.

In risposta alla registrazione dell'app su Edge, Edge assegna una chiave API univoca all'app. L'app deve trasmettere questa chiave API come parte di ogni richiesta a una risorsa API. La chiave viene autenticata e, se valida, la richiesta viene concessa. In qualità di fornitore di servizi, puoi revocare la chiave in qualsiasi momento in modo che l'app non possa più accedere alle tue API.

In qualità di fornitore di API, decidi come registrare le app. Potresti:

  • Utilizzare una procedura manuale che richiede a uno sviluppatore di contattare la tua organizzazione per registrare la propria app. In risposta, invierai allo sviluppatore la chiave API, possibilmente via email.
  • Utilizzare l'API di gestione Edge per integrare la funzionalità di registrazione dell'app e la distribuzione delle chiavi nel tuo sito web.
  • Per un account Edge a pagamento, utilizza il portale Apigee Developer Services, che supporta la registrazione delle app e la distribuzione delle chiavi API.

Per saperne di più, consulta Registrare le app e gestire le chiavi API chiavi.

Attività 4: documenta le tue API

Una considerazione importante per la pubblicazione dei prodotti API è fornire documentazione e un meccanismo di feedback per gli sviluppatori. I portali per sviluppatori con funzionalità di pubblicazione social vengono utilizzati sempre più spesso per la comunicazione con la community di sviluppo. Ciò include la comunicazione di contenuti statici , come la documentazione delle API e i termini di utilizzo, nonché contenuti dinamici forniti dalla community , come blog e forum, e funzionalità di assistenza clienti.

Un diagramma di sequenza da sinistra a destra che mostra uno sviluppatore, un'app, API e servizi di backend. L'icona sviluppatore è evidenziata. Sotto lo sviluppatore c'è una casella che rappresenta un portale per sviluppatori. Il portale contiene documentazione dell'API, esempi, tutorial, Riferimento API e altro ancora. Il portale contiene anche blog, forum e un portale di assistenza. Una linea tratteggiata punta dallo sviluppatore evidenziato a un'icona di un'app creata dallo sviluppatore. Le frecce che vanno e tornano all'app mostrano il flusso di richiesta e risposta a un'icona API, con una chiave dell'app posizionata sopra la richiesta. Sotto l'icona dell'API si trovano due insiemi di percorsi delle risorse raggruppati in due prodotti API: prodotto Location e prodotto Media. Il prodotto Località dispone di risorse per /countries, /cities e /languages, mentre il prodotto Media dispone di risorse per /books, /magazines e /movies. A destra dell'API si trovano le risorse di backend chiamate dall'API, tra cui un database, un bus di servizio aziendale, server di app e un backend generico.

Puoi creare il tuo sito web per eseguire il deployment della documentazione oppure, se hai un account Edge a pagamento, puoi utilizzare il portale Apigee Developer Services. Il portale supporta la documentazione, i blog, i forum e altri tipi di contenuti necessari per supportare la tua community di sviluppatori.

SmartDocs ti consente di documentare le tue API sul portale Developer Services in un modo che la documentazione delle API sia completamente interattiva. La documentazione interattiva con SmartDocs consente agli utenti del portale di:

  • Leggere informazioni sull'API
  • Inviare una richiesta in tempo reale all'API
  • Visualizzare una risposta in tempo reale restituita dall'API

Ad esempio, la figura seguente mostra un'API documentata sul portale utilizzando SmartDocs. Questa API fornisce informazioni meteo per una località specifica:

Un argomento del metodo API SmartDocs che consente di chiamare un'API meteo facendo clic su un pulsante nell'argomento.

Lo sviluppatore inserisce un valore per il parametro di ricerca "w" per specificare la località, quindi fa clic sul pulsante Invia la richiesta per visualizzare la richiesta e la risposta in tempo reale. Creando una documentazione interattiva sulle tue API, semplifichi l'apprendimento, test e la valutazione delle tue API da parte degli utenti del portale.

L'API di gestione Edge è un'API REST che consente di accedere ai servizi API utilizzando qualsiasi client HTTP. Apigee utilizza SmartDocs per creare documentazione interattiva per l'API di gestione Edge. Consulta la documentazione dell'API qui.

Per saperne di più, consulta Utilizzare SmartDocs per documentare le API.