Use API Gateway to access Function Compute - API Gateway: Central de Documentação do Alibaba Cloud

O API Gateway oferece um método seguro e controlado para chamadas de API, facilitando o gerenciamento e o monitoramento dos serviços do Function Compute. Este tópico apresenta um guia rápido sobre como criar uma API no API Gateway e invocá-la para acionar uma web function no Function Compute 3.0. A chamada utiliza o AppCode de um aplicativo conforme o método de autenticação Alibaba Cloud App.

Pré-requisitos

Você deve ter criado uma instância do API Gateway. Para mais informações sobre os tipos de instância, consulte Escolher um tipo de instância.

Visão geral

Neste exemplo, você implanta uma web function no Function Compute 3.0, cria uma API no API Gateway com um serviço de backend associado a essa função e usa o AppCode de um aplicativo autorizado para chamar a API. O exemplo demonstra como controlar o acesso aos serviços do Function Compute por meio do API Gateway. O processo consiste em seis etapas:

Crie uma web function: Construa uma aplicação web baseada no Function Compute 3.0.
Crie um serviço de backend: Defina no API Gateway um serviço de backend que aponte para o Function Compute. Isso garante o encaminhamento preciso das requisições para a web function correspondente, assegurando uma integração perfeita entre frontend e backend.
Crie a API: Crie uma API para que aplicações externas invoquem a web function.
Crie um aplicativo e autorize-o a chamar a API: Estabeleça um mecanismo de autenticação para as chamadas. Isso assegura que apenas aplicativos autorizados acessem a API, aumentando a segurança.
Depure a API: Teste a API criada com a ferramenta de depuração online. Isso permite detectar e resolver problemas, garantindo o funcionamento correto antes da publicação.
Chame a API: Após concluir todas as configurações, a API estará pronta para receber chamadas.

Etapa 1: Crie uma web function

Antes de conectar o API Gateway ao Function Compute, crie uma web function para construir e implantar rapidamente uma aplicação web. Neste exemplo, utilizamos o Function Compute 3.0.

Acesse o console do Function Compute 3.0. No painel de navegação à esquerda, clique em Functions. Na página Functions, selecione uma região na barra de navegação superior.

Importante
Certifique-se de criar a web function na mesma região da sua instância do API Gateway.
Na página Functions, clique em Create Function, selecione Web Function, configure os parâmetros a seguir e clique em Create.
- Basic Settings: Configure o Function Name.
- Code: Configure o runtime e o código da função. Mantenha as configurações padrão de Startup Command e Listening Port.
Na aba Function Details, exibida automaticamente após a criação da função, clique na aba Configurations. Na árvore de navegação à esquerda, clique em Triggers. Localize o trigger desejado e copie seu endpoint interno https://***-helloworld-**.cn-hangzhou.fcapp.run na coluna Configurations.

Etapa 2: Crie um serviço de backend

O API Gateway permite configurar serviços de backend como recursos regionais para simplificar o gerenciamento. Basta criar o serviço no console do API Gateway e definir uma url para associá-lo ao Function Compute.

Acesse o console do API Gateway. No painel de navegação à esquerda, escolha Manage APIs > Backend Services. Selecione uma região na barra de navegação superior e clique em Create Backend Service.
Na caixa de diálogo Create Backend Service, configure os parâmetros e clique em Confirm. A figura a seguir mostra um exemplo:
Na página Backend Services, clique no serviço de backend criado. Na página Backend Service Definition, clique na aba Production. Na seção Basic Information, clique em Create.
Na seção Basic Information da página exibida, defina o Trigger Path como https://***-helloworld-**.cn-hangzhou.fcapp.run, copiado anteriormente na etapa Criar uma web function. Em seguida, clique em Publish.

Etapa 3: Crie uma API

Nesta etapa, crie uma API para que aplicações externas a chamem usando métodos específicos. A chamada invoca a web function associada. Grupos de APIs gerenciam as APIs com base em políticas unificadas de segurança e tráfego.

Acesse o console do API Gateway. No painel de navegação à esquerda, escolha Manage APIs > API Groups. Na página API Groups, clique em Create Group no canto superior direito.
Na caixa de diálogo Create Group, selecione uma instância na lista suspensa Instances, defina Group Name como FC-Group e BasePath como /, e clique em Confirm.
Após criar o grupo, clique em Manage APIs na coluna Actions do grupo para acessar a página de APIs.
Clique em Create API. Na etapa Basic Information, configure os parâmetros a seguir e clique em Next:
Na etapa Define API Request, defina Request Path como /, mantenha os valores padrão dos demais parâmetros e clique em Next.
Na etapa Define Backend Service, configure os parâmetros a seguir e clique em Next:
Na etapa Define Response, mantenha as configurações padrão e clique em Create. Após criar a API, localize-a na página de APIs e clique em Publish na coluna Actions.
Na caixa de diálogo Publish API, configure os parâmetros a seguir e clique em Publish.

Etapa 4: Crie um aplicativo e autorize-o a chamar a API

Um aplicativo representa a identidade usada pelo chamador para acessar a API. Neste exemplo, Alibaba Cloud App foi selecionado como parâmetro Security Authentication na etapa Criar uma API. Portanto, após publicar a API, crie um aplicativo e autorize-o a fazer chamadas.

Acesse o console do API Gateway. No painel de navegação à esquerda, escolha Call APIs < Apps.
Na página Apps, clique em Create App no canto superior direito. Na caixa de diálogo Create App, defina App Name como fcAPP e clique em Confirm.
Na página Apps, clique no aplicativo fcApp criado. Na página App Details, observe dois métodos de autenticação disponíveis: AppKey e AppCode. O método AppKey inclui um par de AppKey e AppSecret, funcionando de maneira semelhante a nome de usuário e senha. Ao chamar a API, passe o AppKey como parâmetro. O AppSecret calcula as assinaturas. O API Gateway verifica o par AppKey-AppSecret para autenticar sua identidade.
No painel de navegação à esquerda, escolha Manage APIs > APIs. Na página de APIs, localize a API FC-test criada e clique em > Authorize na coluna Actions.
Na página Authorize, defina o parâmetro Stage como Release. Insira fcApp na barra de pesquisa da seção Escolha aplicativos para autorização. Nos resultados, selecione o aplicativo criado, clique em Add na coluna Actions e clique em Confirm. Uma mensagem confirmará a autorização do aplicativo para chamar a API.

Etapa 5: Depure a API

Teste a API criada com a ferramenta de depuração online. Isso garante a detecção e resolução de problemas, assegurando o funcionamento correto antes da publicação.

Acesse o console do API Gateway. No painel de navegação à esquerda, escolha Call APIs > Debug.
Na página Debug, selecione a API FC-test criada, defina Verification Method como Use AppCode e clique em Send Request. As informações a seguir indicam configuração bem-sucedida:

Etapa 6: Chame a API

Após criar, publicar, autorizar e depurar a API nas etapas anteriores, use o AppCode fornecido pelo API Gateway para chamar a API publicada a partir de um sistema empresarial. Para mais informações sobre chamadas de API, consulte Chamar uma API usando autenticação simples (AppCode). Neste exemplo, usamos cURL.

Acesse o console do API Gateway. No painel de navegação à esquerda, escolha Call APIs > Apps. Na página Apps, clique no aplicativo autorizado e obtenha o AppCode na página exibida. Em seguida, use o código de exemplo a seguir para chamar a API:

curl -i -X GET "http://fd6f8e2b7bf44ab181a56****-cn-hangzhou.alicloudapi.com" -H "Authorization:APPCODE 7d2b7e4945ce44028ab00***"

A figura a seguir mostra o resultado da chamada de API: