Tutorial: Crie uma API REST com uma integração de não proxy de HTTP

Como criar uma API

1. Inicie uma sessão no console do API Gateway em https://console.aws.amazon.com/apigateway.

2. Se esta for a primeira vez que você usa o API Gateway, você verá uma página com os recursos do serviço. Em REST API, escolha Build (Criar). Quando o pop-up Create Example API (Criar API de exemplo) for exibido, escolha OK.

   Se essa não for a primeira vez que você usa o API Gateway, escolha Create API (Criar API). Em REST API, escolha Build (Criar).

3. Em API name (Nome da API), insira HTTPNonProxyAPI.

4. (Opcional) Em Description (Descrição), insira uma descrição.

5. Mantenha Tipo de endpoint de API definido como Regional.

6. Selecione Criar API.

Como criar um recurso /pets

1. Selecione Criar recurso.

2. Mantenha Recurso proxy desativado.

3. Mantenha Caminho do recurso como /.

4. Em Resource Name (Nome do recurso), insira pets.

5. Mantenha CORS (Compartilhamento de recursos de origem cruzada) desativado.

6. Selecione Criar recurso.

Como criar um método GET no recurso /pets

1. Selecione o recurso /pets.

2. Escolha Criar método.

3. Em Tipo de método, selecione GET.

4. Em Tipo de integração, selecione Integração HTTP.

5. Mantenha a opção Integração do proxy HTTP desativada.

6. Em Método HTTP, selecione GET.

7. Em URL do endpoint, insira http://petstore-demo-endpoint.execute-api.com/petstore/pets.

   O site PetStore permite que você recupere uma lista de itens Pet por tipo de animal de estimação, por exemplo, “Cão” ou “Gato”, em uma página específica.

8. Em Manuseio de conteúdo, selecione Passagem.

9. Selecione Parâmetros de string de consulta de URL.

   Ele usa os parâmetros de string de consulta type e page para aceitar uma entrada. Adicione os parâmetros de string de consulta à solicitação de método e mapeie-os para os parâmetros de string de consulta correspondentes da solicitação de integração.

10. Para adicionar parâmetros de string de consulta, faça o seguinte:

    1. Escolha Add query string (Adicionar string de consulta).

    2. Em Nome, insira type.

    3. Mantenha Obrigatório e Armazenamento em cache desativados.

    Repita as etapas anteriores para criar uma string de consulta adicional com o nome page.

11. Escolha Criar método.

Como associar parâmetros de entrada à solicitação de integração

1. Na guia Solicitação de integração, em Configurações de solicitação de integração, selecione Editar.

2. Selecione Parâmetros de string de consulta de URL e faça o seguinte:

   1. Selecione Adicionar parâmetro de string de consulta.

   2. Em Nome, digite type.

   3. Em Mapeado de, insira method.request.querystring.type.

   4. Mantenha Armazenamento em cache desativado.

   5. Selecione Adicionar parâmetro de string de consulta.

   6. Em Nome, digite page.

   7. Em Mapeado de, insira method.request.querystring.page.

   8. Mantenha Armazenamento em cache desativado.

3. Escolha Salvar.

Como testar a API

1. Selecione a guia Testar. Talvez seja necessário selecionar o botão de seta para a direita para mostrar a guia.

2. Em Strings de consulta, digite type=Dog&page=2.

3. Escolha Testar.

   O resultado é semelhante ao seguinte:

   

   Agora que o teste foi bem-sucedido, podemos implantar a API para torná-la disponível publicamente.

4. Escolha Implantar API.

5. Em Estágio, selecione Novo estágio.

6. Em Stage name (Nome do estágio), insira Prod.

7. (Opcional) Em Description (Descrição), insira uma descrição.

8. Escolha Implantar.

9. (Opcional) Em Detalhes do estágio, para Invocar URL, é possível selecionar o ícone de cópia para copiar o URL de invocação da API. Você pode usá-lo com ferramentas, como Postman e cURL para testar sua API.

Como criar o recurso {petId}

1. Selecione o recurso /pets e, depois, escolha Criar recurso.

2. Mantenha Recurso proxy desativado.

3. Em Caminho do recurso, selecione/pets.

4. Em Resource Name (Nome do recurso), insira {petId}.

   Use as chaves ({ }) ao redor de petId para que /pets/{petId} seja exibido.

5. Mantenha CORS (Compartilhamento de recursos de origem cruzada) desativado.

6. Selecione Criar recurso.

Como configurar o método GET

1. Selecione o recurso /{petId} e, depois, Criar método.

2. Em Tipo de método, selecione GET.

3. Em Tipo de integração, selecione Integração HTTP.

4. Mantenha a opção Integração do proxy HTTP desativada.

5. Em Método HTTP, selecione GET.

6. Em URL do endpoint, insira http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}.

7. Em Manuseio de conteúdo, selecione Passagem.

8. Mantenha o Tempo limite padrão ativado.

9. Escolha Criar método.

Como associar o parâmetro de caminho {petId}

1. Na guia Solicitação de integração, em Configurações de solicitação de integração, selecione Editar.

2. Selecione Parâmetros de caminho de URL.

3. O API Gateway cria um parâmetro de caminho para a solicitação de integração chamado petId, mas ele não é válido para o URL do endpoint HTTP que você define como a integração de backend. O endpoint HTTP usa {id} como o parâmetro de caminho. Em Nome, exclua petId e insira id.

   Isso mapeia o parâmetro de caminho da solicitação de método de petId para o parâmetro de caminho da solicitação de integração de id.

4. Escolha Salvar.

Como testar o método 

1. Selecione a guia Testar. Talvez seja necessário selecionar o botão de seta para a direita para mostrar a guia.

2. Em Caminho para petId, insira 4.

3. Escolha Test (Testar).

   Se bem-sucedido, o Corpo da resposta exibirá o seguinte:

   {
     "id": 4,
     "type": "bird",
     "price": 999.99
   }

Para implantar a API

1. Escolha Implantar API.

2. Em Estágio, selecione Prod.

3. (Opcional) Em Description (Descrição), insira uma descrição.

4. Escolha Deploy (Implantar).

1. No painel de navegação principal, selecione Estágio.

2. Em Detalhes do estágio, escolha o ícone de cópia para copiar o URL de invocação da API.

   A aparência será semelhante à seguinte:

   https://my-api-id.execute-api.region-id.amazonaws.com/prod

3. Insira este URL na caixa de endereço da nova guia do navegador e anexe /pets/4 ao URL antes de enviar a solicitação.

4. O navegador exibirá o seguinte:

   {
     "id": 4,
     "type": "bird",
     "price": 999.99
   }