As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Chamar uma API REST no Amazon API Gateway
Para chamar uma API implantada, os clientes enviam solicitações ao URL do serviço de componente do API Gateway para execução da API, conhecido como execute-api.
A URL base para APIs REST está no seguinte formato:
https://restapi_id.execute-api.region.amazonaws.com/stage_name/
onde restapi_id é o identificador da API, region é a AWS região e stage_name é o nome artístico da implantação da API.
Importante
Antes de invocar uma API, você deve implantá-la no API Gateway. Para obter instruções sobre como implantar uma API, consulteImplantar uma API REST no Amazon API Gateway.
Tópicos
Obtendo o URL de invocação de uma API
Você pode usar o console AWS CLI, o ou uma definição de OpenAPI exportada para obter o URL de invocação de uma API.
Obtendo o URL de invocação de uma API usando o console
O procedimento a seguir mostra como obter o URL de invocação de uma API no console da API REST.
Para obter o URL de invocação de uma API usando o console da API REST
Inicie uma sessão no console do API Gateway em https://console.aws.amazon.com/apigateway
. Escolha uma API implantada.
-
No painel de navegação principal, escolha Estágio.
-
Em Detalhes do estágio, escolha o ícone de cópia para copiar o URL de invocação da API.
Esse URL é para o recurso raiz da sua API.
Para obter o URL de invocação de uma API para outro recurso em sua API, expanda o estágio no painel de navegação secundário e escolha um método.
Escolha o ícone de cópia para copiar o URL de invocação em nível de recurso da sua API.
Obtendo o URL de invocação de uma API usando o AWS CLI
O procedimento a seguir mostra como obter o URL de invocação de uma API usando o. AWS CLI
Para obter o URL de invocação de uma API usando o AWS CLI
Use o comando a seguir para obter
rest-api-ido. Esse comando retorna todos osrest-api-idvalores em sua região. Para obter mais informações, consulte get-rest-apis.aws apigateway get-rest-apisSubstitua o exemplo
rest-api-idpelo seurest-api-id, substitua o exemplo{stage-name}pelo seu{stage-name}e substitua o{region} pela sua região.https://{restapi_id}.execute-api.{region}.amazonaws.com/{stage_name}/
Obter o URL de invocação de uma API usando o arquivo de definição OpenAPI exportado da API
Você também pode criar o URL raiz combinando os basePath campos host e de um arquivo de definição de OpenAPI exportado da API. Para obter instruções sobre como exportar sua API, consulteExportar uma API REST do API Gateway.
Invocação de uma API
Além disso, você pode usar o console do API Gateway para testar uma chamada de API. O teste usa o TestInvoke recurso do API Gateway, que permite testar a API antes da implantação da API. Para ter mais informações, consulte Use o console do API Gateway para testar um método de API REST.
nota
Os valores de parâmetros de strings de consulta em uma URL de invocação não podem conter %%.
Invocando uma API usando um navegador da web
Se sua API permitir acesso anônimo, você poderá usar qualquer navegador da Web para invocar qualquer GET método. Insira o URL de invocação completo na barra de endereço do navegador.
Para outros métodos ou quaisquer chamadas que exijam autenticação, você deve especificar uma carga ou assinar as solicitações. Você pode lidar com isso em um script por trás de uma página HTML ou em um aplicativo cliente usando um dos AWS SDKs.
Invocando uma API usando curl
Você pode usar uma ferramenta como curlgetUsers recurso do prod estágio de uma API.
