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 sul portale eseguendo i seguenti passaggi:

  1. Crea un proxy API da una specifica
  2. Crea un prodotto API
  3. Pubblica l'API sul 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. Nella console Apigee in Cloud, vai alla pagina Proxy Development > API proxies (Sviluppo proxy > Proxy API).

    Vai ai proxy API

  2. Fai clic su Crea. Si apre la procedura guidata Crea un proxy che ti chiede di selezionare il tipo di proxy API da creare.

  3. Fai clic nella casella Modello proxy.

  4. Fai clic su Modello di specifica OpenAPI, proxy inverso (il più comune).

  5. Apri il seguente file in un browser, quindi salvalo: 

    https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml

  6. Nel passaggio 1: specifiche OpenAPI, fai clic su Sfoglia.

  7. Vai a un file di specifica OpenAPI appena scaricato, selezionalo e fai clic su Apri.

  8. Fai clic su Avanti.

  9. In Passaggio 2 Dettagli proxy, i campi vengono precompilati utilizzando i valori della specifica OpenAPI. Modifica il campo Descrizione come segue: Proxy API per Hello World.

  10. Fai clic su Avanti.

  11. In Passaggio 3 Flussi, seleziona tutte le operazioni.

  12. Fai clic su Avanti.

  13. Nel passaggio 4 Esegui il deployment, seleziona l'ambiente in cui vuoi eseguire il deployment.

  14. Fai clic su OK.

  15. Fai clic su Crea.

Quando il proxy viene sottoposto a deployment, la colonna Stato nella sezione Deployment mostra un'icona verde per indicare che la revisione del proxy API è stata sottoposta a deployment. Puoi tenere il puntatore sopra l'icona di stato per visualizzare ulteriori informazioni sull'implementazione.

Passaggio 2: crea un prodotto API

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

Per creare un prodotto API:

  1. Nella console Apigee in Cloud, vai alla pagina Distribuzione > Prodotti API.

    Vai ai prodotti API

  2. Fai clic su Crea. Viene visualizzata la pagina Dettagli prodotto. Inserisci i dettagli del prodotto per il tuo prodotto API.

    Campo Valore
    Nome Hello World
    Nome visualizzato Hello World
    Descrizione Semplice esempio di Hello World
    Ambiente Seleziona l'ambiente in cui viene eseguito il deployment del proxy API.
    Accesso Pubblica
    Approva automaticamente le richieste di accesso Abilitata
    Quota (lasciare vuoto)
    Ambiti OAuth consentiti (lasciare vuoto)

  3. Nella sezione Operazioni, fai clic su Aggiungi un'operazione per identificare le operazioni da aggiungere al prodotto API.

    • In Origine, seleziona Proxy API e poi Mock-Target-API dal menu a discesa.
    • In Operazione, inserisci una barra (/) nel campo Percorso. Ignora gli altri campi.

  4. Fai clic su Salva per salvare l'operazione.

  5. Fai clic su Salva per salvare il prodotto.

Passaggio 3: pubblica l'API sul tuo portale

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

Per pubblicare l'API sul tuo portale:

  1. Nella console Apigee in Cloud, vai alla pagina Distribuzione > Portali.

    Vai a Portali

  2. Fai clic sulla riga Il mio primo portale per aprire il portale.

  3. Fai clic sulla scheda API.

  4. Fai clic su + API.

  5. Per Prodotto API, seleziona Hello World.

  6. Seleziona Pubblicato (elencato nel catalogo) per pubblicare l'API nel tuo portale.

  7. In Titolo visualizzato, inserisci Hello World.

  8. Per Immagine visualizzata, fai clic su Seleziona.

  9. Fai clic su Asset.

  10. Fai clic su Anteprima per home-background.jpg.

  11. Fai clic su Seleziona.

  12. Per la documentazione dell'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.
    3. Fai clic sulla scheda URL.
    4. Digita helloworld nel campo Nome spec.
    5. Copia e incolla il seguente URL nel campo URL: 
      https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
    6. Fai clic su Seleziona.

  13. Fai clic su Salva.

Passaggio 4: visualizza la documentazione di riferimento dell'API

Per visualizzare la documentazione di riferimento dell'API:

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

API di destinazione simulata pubblicata con il riquadro Prova questa API