Documentazione di Oracle Cloud Infrastructure

Guida al gateway API QuickStart

Scopri come iniziare rapidamente con API Gateway.

A. Impostare la tenancy

1 Creare gruppi e utenti

Se gli utenti e i gruppi idonei per creare e accedere al gateway API e alle risorse di rete non esistono già:

  1. Collegarsi alla console come amministratore della tenancy.
  2. Aprire il menu di navigazione e selezionare Identità e sicurezza. In Identità, selezionare Domini.

  3. Creare un nuovo gruppo selezionando Gruppi, quindi Crea gruppo.

    Questa immagine mostra la finestra di dialogo Crea gruppo, con campi Nome e Descrizione vuoti.

  4. Creare un nuovo utente selezionando Utenti, quindi Crea utente.

    Questa immagine mostra la finestra di dialogo Crea utente, con i campi Nome, Descrizione, E-mail e Conferma e-mail vuoti.

  5. Aggiungere un utente a un gruppo selezionando Gruppi, il nome del gruppo e quindi Aggiungi utente al gruppo.

    Questa immagine mostra la finestra di dialogo Aggiungi utente al gruppo, con un campo Utenti vuoto.

Per ulteriori informazioni, consulta istruzioni dettagliate.

2. Crea compartimento

Se un compartimento adatto in cui creare le risorse e le risorse di rete del gateway API non esiste già:

  1. Collegarsi alla console come amministratore della tenancy.
  2. Aprire il menu di navigazione e selezionare Identità e sicurezza. In Identità selezionare Compartimenti.

  3. Selezionare Crea compartimento.

    Questa immagine mostra la finestra di dialogo Crea compartimento, con campi Nome e Descrizione vuoti.

Per ulteriori informazioni, consulta istruzioni dettagliate.

3 Crea VCN e subnet

Per garantire l'alta disponibilità, puoi creare gateway API solo nelle subnet regionali (non nelle subnet specifiche di AD). Se una VCN appropriata con una subnet regionale pubblica in cui creare le risorse di rete non esiste già:

  1. Collegarsi alla console come amministratore della tenancy.
  2. Aprire il menu di navigazione , selezionare Networking, quindi selezionare Reti cloud virtuali.
  3. Selezionare Avvia procedura guidata VCN per creare una nuova VCN.

  4. Nella finestra di dialogo Avvia procedura guidata VCN, selezionare Crea VCN con connettività Internet e selezionare Avvia procedura guidata VCN.

    Questa immagine mostra la finestra di dialogo Avvia procedura guidata VCN, con l'opzione "Crea VCN con connettività Internet" selezionata.

    Oltre alla VCN, il workflow crea una subnet regionale pubblica e una subnet regionale privata, insieme a un gateway Internet, un gateway NAT e un gateway del servizio.

  5. Immettere un nome per la nuova VCN e specificare i blocchi CIDR per la VCN, la subnet regionale pubblica (deve fornire almeno 32 indirizzi IP gratuiti) e la subnet regionale privata.

    Questa immagine mostra la pagina Configurazione del workflow Crea una VCN con connettività Internet. I campi Blocco CIDR VCN, Blocco CIDR della subnet pubblica e Blocco CIDR della subnet privata contengono valori predefiniti (rispettivamente 10.0.0.0/16, 10.0.0.0/24 e 10.0.1.0/24).

  6. Selezionare Avanti per esaminare i dettagli immessi per la nuova VCN e selezionare Crea per crearla. Una volta creata la VCN, selezionare Visualizza rete cloud virtuale per visualizzare la nuova VCN e le subnet create.

    Questa immagine mostra la pagina Revisione e creazione del flusso di lavoro Crea una VCN con connettività Internet, con tutte le risorse visualizzate come create. Viene visualizzato il pulsante Visualizza rete cloud virtuale.

    Il gateway API comunica sulla porta 443, che non è aperta per impostazione predefinita. È necessario aggiungere una nuova regola di entrata con conservazione dello stato per la subnet regionale pubblica per consentire il traffico sulla porta 443.

  7. Selezionare il nome della subnet regionale pubblica, il nome della lista di sicurezza predefinita e quindi selezionare Aggiungi regole di entrata. Specificare:
    • Tipo di origine: CIDR
    • CIDR di origine: 0.0.0.0/0
    • Protocollo IP: TCP
    • Intervallo porte di origine: tutto
    • Intervallo di porte di destinazione: 443
    Questa immagine mostra la finestra di dialogo Aggiungi regole di entrata, con i valori predefiniti in tutti i campi.
  8. Selezionare Aggiungi regole di entrata per aggiungere la nuova regola alla lista di sicurezza predefinita.

Per ulteriori informazioni, consulta istruzioni dettagliate.

4 Crea criteri IAM

Se uno o più sviluppatori API non sono amministratori della tenancy:

  1. Collegarsi alla console come amministratore della tenancy.
  2. Aprire il menu di navigazione e selezionare Identità e sicurezza. In Identità, selezionare Criteri.

  3. Creare criteri per concedere agli sviluppatori API l'accesso:

    Questa immagine mostra la pagina Crea criterio, con tutti i campi vuoti. L'opzione Mostra editor manuale è stata selezionata.

    1. Creare un criterio con un'istruzione criterio per consentire agli sviluppatori API di accedere alle risorse correlate al gateway API. Selezionare Crea criterio, specificare un nome e una descrizione per il nuovo criterio e selezionare il compartimento proprietario delle risorse correlate al gateway API. Utilizzare l'Editor manuale di Policy Builder per immettere la seguente istruzione di criterio, quindi selezionare Crea:
      Allow group <group-name> to manage api-gateway-family in compartment <compartment-name>
    2. Creare un criterio con un'istruzione criterio per consentire agli sviluppatori API di accedere alle risorse di rete. Selezionare Crea criterio, specificare un nome e una descrizione per il nuovo criterio e selezionare il compartimento proprietario delle risorse di rete da utilizzare con il gateway API. Utilizzare l'Editor manuale di Policy Builder per immettere la seguente istruzione di criterio, quindi selezionare Crea:
      Allow group <group-name> to manage virtual-network-family in compartment <compartment-name>

    Nota: i criteri di cui sopra sono sufficienti per consentire la creazione di una distribuzione API con un backend HTTP, come suggerito in questa guida QuickStart. È possibile immettere criteri aggiuntivi (come descritto nella documentazione) per consentire agli sviluppatori di API di creare distribuzioni API con le funzioni OCI Functions come backend e per consentire ai gateway API di eseguire l'autenticazione con un server cache per recuperare i dati di risposta inseriti nella cache.

Per ulteriori informazioni, consulta istruzioni dettagliate.

B. Crea, distribuisci e chiama la tua API

1 Crea il primo gateway API
  1. Accedere alla console come sviluppatore di API Gateway, aprire il menu di navigazione e selezionare Developer Services. In Gestione API selezionare Gateway.
  2. Selezionare Crea gateway e specificare:
    • un nome per il nuovo gateway, ad esempio acme-api-gateway
    • il tipo di nuovo gateway come pubblico;
    • il nome del compartimento in cui creare le risorse del gateway API
    • il nome della VCN da utilizzare con il gateway API
    • il nome della subnet regionale pubblica nella VCN
    Questa immagine mostra la finestra di dialogo Crea gateway, con tutti i campi vuoti per impostazione predefinita, ad eccezione del campo Tipo impostato su Pubblico per impostazione predefinita.
  3. Selezionare Crea.

    Una volta creato, il nuovo gateway API viene visualizzato come attivo nella lista della pagina Gateway.

Per ulteriori informazioni, consulta istruzioni dettagliate.

2 Creare la prima distribuzione API
  1. Nella pagina Gateway della console, selezionare il nome del gateway API creato in precedenza.
  2. In Risorse selezionare Distribuzioni, quindi selezionare Crea distribuzione.

  3. Selezionare Da zero e nella sezione Informazioni di base specificare:

    • un nome per la nuova distribuzione API, ad esempio acme-api-deployment
    • un prefisso di percorso da aggiungere al percorso di ogni instradamento contenuto nella distribuzione API, ad esempio /v1
    • compartimento in cui creare la nuova distribuzione API

    Questa immagine mostra la pagina Informazioni di base del workflow Crea distribuzione, con l'opzione Da zero selezionata. Gli altri campi sono vuoti per impostazione predefinita.

  4. Selezionare Avanti e nella sezione Percorso 1 specificare quanto segue.

    • un percorso, ad esempio /hello
    • un metodo accettato dal servizio backend, ad esempio GET
    • il tipo di servizio backend e i dettagli associati. Per comodità, specificare il tipo come HTTP e immettere un'API pubblica come URL del backend (ad esempio https://api.weather.gov).

    Questa immagine mostra la pagina Instradamenti del workflow Crea distribuzione, con tutti i campi vuoti per impostazione predefinita.

  5. Selezionare Avanti per esaminare i dettagli immessi per la nuova distribuzione API e selezionare Crea per crearla.

    Questa immagine mostra la pagina Revisione del workflow Crea distribuzione. Nella sezione Informazioni di base, il campo Nome contiene acme-api-deployment e il campo Prefisso percorso contiene /v1. Nella sezione Criteri di log, il campo Livello log di esecuzione contiene informazioni.

    Una volta creata, la nuova distribuzione API viene visualizzata come Attiva nella lista delle distribuzioni API.

  6. Quando la distribuzione dell'API è attiva, passare al task successivo.

Per ulteriori informazioni, consulta le istruzioni dettagliate.

3 Chiama la prima API

  1. Nella lista delle distribuzioni API, selezionare Copia accanto all'endpoint della nuova distribuzione API appena creata per copiare l'endpoint.

  2. Aprire una finestra di terminale e chiamare l'API immettendo:

    curl -k -X GET <deployment-endpoint>

    dove <deployment-endpoint> è l'endpoint copiato nel passo precedente. Ad esempio, https://lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com/v1/hello

Complimenti. Hai appena creato il tuo primo gateway API e la prima distribuzione API e hai chiamato la tua prima API utilizzando il servizio gateway API.

Per ulteriori informazioni, consulta istruzioni dettagliate.

4. Passi successivi

Dopo aver creato, distribuito e chiamato una funzione API, scopri come:

Procedura completata.