Documentação do Oracle Cloud Infrastructure

Chamando uma API Implantada em um Gateway de API

Descubra como chamar uma API que você implantou anteriormente em um gateway de API com o serviço de Gateway de API.

Tendo implantado uma API em um gateway de API, você pode chamar a API implantada.

Dica

Ao montar o comando curl descrito neste tópico, você pode obter rapidamente o valor da string https://<gateway-hostname>/<deployment-path-prefix> como o ponto final de implantação de API usando:

  • A Console, indo para a página Detalhes do Gateway e selecionando Copiar ao lado do ponto final da implantação de API.
  • A API, usando a operação GetDeployments.

Usando o curl

Para chamar uma API implantada em um gateway de API:

  1. Abra uma janela de terminal e digite um comando cURL semelhante ao seguinte apropriado para a API implantada:

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

    em que:

    • <method> é um método válido para a API implantada (por exemplo, GET, PUT).

    • <gateway-hostname> é um nome de domínio gerado automaticamente no formato <gateway-identifier>.apigateway.<region-identifier>.oci.customer-oci.com, em que:

      • <gateway-identifier> é a string de caracteres que identifica o gateway de API. Por exemplo, lak...sjd (abreviado para fins de legibilidade).
      • <region-identifier> é o identificador da região na qual o gateway de API foi criado. Consulte Disponibilidade por Região.

      Por exemplo, lak...sjd.apigateway.us-phoenix-1.oci.customer-oci.com.

      Use a Console ou a API para descobrir o nome do domínio a ser usado como o valor de <gateway-hostname>.

    • /<deployment-path-prefix> é o prefixo adicionado ao caminho de cada rota na implantação de API. Observe que o prefixo do caminho de implantação na solicitação:

      • pode conter várias barras (desde que elas não sejam adjacentes)
      • pode incluir caracteres alfanuméricos maiúsculos e minúsculos
      • pode incluir os caracteres especiais $ - _ . + ! * ' ( ) , % ; : @ & =
      • não pode incluir parâmetros e curingas
      • deve corresponder exatamente ao prefixo do caminho de implantação definido para a implantação de API (consulte Implantando uma API em um Gateway de API por meio da Criação de uma Implantação de API)

      Use a Console ou a API para descobrir o prefixo do caminho a ser usado como o valor de <deployment-path-prefix>.

    • /<api-route-path> é o caminho para uma rota específica definida na especificação de implantação de API. Observe que o caminho da rota na solicitação:

      • é relativo ao prefixo do caminho de implantação
      • pode ser uma barra simples
      • pode conter várias barras (desde que elas não sejam adjacentes) e pode terminar com uma barra
      • pode incluir caracteres alfanuméricos maiúsculos e minúsculos
      • pode incluir os caracteres especiais $ - _ . + ! * ' ( ) , % ; : @ & =
      • não precisa corresponder exatamente ao caminho de rota definido na especificação de implantação de API, desde que o caminho da rota na especificação de implantação de API inclua um parâmetro de caminho com ou sem um curinga (consulte Adicionando Parâmetros de Caminho e Curingas a Caminhos de Rota)

      Use a Console ou a API para descobrir o caminho a ser usado como o valor de <api-route-path>.

    Por exemplo:

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

    Se o back-end do gateway de API for uma função sem servidor que aceite parâmetros, inclua esses parâmetros na chamada à API. Por exemplo:

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