Documentazione di Oracle Cloud Infrastructure

Chiamata di un'interfaccia API distribuita in un gateway API

Scopri come chiamare un'interfaccia API precedentemente distribuita in un gateway API con il servizio Gateway API.

Dopo aver distribuito un'API su un gateway API, è possibile chiamare l'API distribuita.

Suggerimento

Durante l'assemblaggio del comando curl descritto in questo argomento, è possibile ottenere rapidamente il valore della stringa https://<gateway-hostname>/<deployment-path-prefix> come endpoint della distribuzione API utilizzando:

  • Nella console, andare alla pagina Dettagli gateway e fare clic su Copia accanto all'endpoint della distribuzione API.
  • L'interfaccia API, utilizzando l'operazione GetDeployments.

Utilizzo di curl

Per chiamare un'API distribuita in un gateway API, effettuare le operazioni riportate di seguito.

  1. Aprire una finestra di terminale e digitare un comando cURL simile al seguente appropriato per l'API distribuita:

    curl -k -X <method> https://<gateway-hostname>/<deployment-path-prefix>/<api-route-path>

    dove:

    • <method> è un metodo valido per l'interfaccia API distribuita (ad esempio, GET, PUT).

    • <gateway-hostname> è un nome di dominio generato automaticamente nel formato <gateway-identifier>.apigateway.<region-identifier>.oci.customer-oci.com, dove:

      • <gateway-identifier> è la stringa di caratteri che identifica il gateway API. Ad esempio, lak...sjd (abbreviato per leggibilità).
      • <region-identifier> è l'identificativo dell'area in cui è stato creato il gateway API. Vedere Disponibilità per area.

      Ad esempio, lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com.

      Utilizzare la Console o l'API per individuare il nome di dominio da utilizzare come valore di <gateway-hostname>.

    • /<deployment-path-prefix> è il prefisso aggiunto al percorso di ogni instradamento nella distribuzione API. Si noti che il prefisso del percorso di distribuzione nella richiesta:

      • può contenere più barre in avanti (a condizione che non siano adiacenti)
      • può includere caratteri alfanumerici maiuscoli e minuscoli
      • può includere i caratteri speciali $ - _ . + ! * ' ( ) , % ; : @ & =
      • impossibile includere parametri e caratteri jolly
      • deve corrispondere esattamente al prefisso del percorso di distribuzione definito per la distribuzione API (vedere Distribuzione di un'API in un gateway API mediante la creazione di una distribuzione API).

      Utilizzare la Console o l'API per individuare il prefisso del percorso da utilizzare come valore di <deployment-path-prefix>.

    • /<api-route-path> è il percorso di un instradamento specifico definito nella specifica di distribuzione API. Si noti che il percorso del percorso nella richiesta:

      • è relativo al prefisso del percorso di distribuzione
      • può essere una singola barra
      • può contenere più barre in avanti (a condizione che non siano adiacenti) e può terminare con una barra in avanti
      • può includere caratteri alfanumerici maiuscoli e minuscoli
      • può includere i caratteri speciali $ - _ . + ! * ' ( ) , % ; : @ & =
      • non deve corrispondere esattamente al percorso di instradamento definito nella specifica di distribuzione API, a condizione che il percorso di instradamento nella specifica di distribuzione API includa un parametro di percorso con o senza un carattere jolly (vedere Aggiunta di parametri di percorso e caratteri jolly ai percorsi di instradamento)

      Utilizzare la Console o l'API per individuare il percorso da utilizzare come valore di <api-route-path>.

    Ad esempio:

    curl -k -X GET https://lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com/marketing/hello/

    Se il backend del gateway API è una funzione serverless che accetta i parametri, includere tali parametri nella chiamata all'API. Ad esempio:

    curl -k -X POST https://lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com/marketing/hello/ -d "name=john"