Crie e publique uma API no API Gateway com o EventBridge como serviço de backend e, em seguida, chame a API usando autenticação AppCode.
Visão geral
Siga as etapas abaixo, em ordem, para criar e publicar uma API com o EventBridge como serviço de backend:
Crie um serviço de backend
Crie um grupo de APIs
Crie uma API
Crie um aplicativo e conceda a ele permissões para chamar a API
Depure a API
Chame a API
Pré-requisitos
Ative o serviço EventBridge e crie um barramento de eventos personalizado. Para mais informações, consulte Gerenciar barramentos de eventos personalizados.
Etapa 1: Criar um serviço de backend
Faça login no console do API Gateway. No painel de navegação à esquerda, escolha Manage APIs > Backend Services.
No canto superior direito da página, clique em Create Backend Service. Na caixa de diálogo exibida, insira o nome do serviço de backend, defina Type como EventBridge e clique em Confirm.
Na página Backend Services, localize o serviço de backend criado e selecione Configure Backend Service and View Associated APIs na coluna Actions.
Clique na aba Production e clique em Create no canto superior direito da seção Basic Information para configurar o serviço de backend no ambiente Production. Configure o serviço de backend no ambiente Production antes de publicar uma API nesse ambiente.
Na página Define Backend Service, selecione um barramento de eventos criado no console do EventBridge.
Se o barramento de eventos selecionado e sua instância do API Gateway estiverem na mesma região, o API Gateway enviará um evento ao barramento quando você chamar a API pela rede interna. Neste exemplo, tanto o barramento de eventos quanto a instância do API Gateway residem na região China (Hangzhou). Após definir os parâmetros, clique em Publish.
Etapa 2: Criar um grupo de APIs
As APIs são gerenciadas em grupos. Crie um grupo de APIs antes de criar uma API individual.
No painel de navegação à esquerda do console do API Gateway, escolha Manage APIs > API Groups. No canto superior direito da página, clique em Create Group. Na caixa de diálogo exibida, selecione uma instância, insira um nome para o grupo e defina um caminho base. O grupo de APIs deve residir na same region do barramento de eventos utilizado.
Após a criação, o grupo aparecerá na página API Groups. Clique no nome do grupo para acessar a página Group Details, onde é possível vincular um nome de domínio, modificar informações básicas e alterar o tipo de instância.
O API Gateway atribui automaticamente um public second-level domain name ao grupo de APIs. Esse domínio serve apenas para depuração e testes. Se utilizá-lo para chamadas de API, o limite será de 100 chamadas por dia em regiões fora da China continental e 1,000 chamadas por dia em regiões dentro da China continental. Recomendamos vincular an independent domain name após criar o grupo de APIs. Neste exemplo, utiliza-se o nome de domínio de segundo nível padrão.
Etapa 3: Criar uma API
No painel de navegação à esquerda do console do API Gateway, escolha Manage APIs-APIs. No canto superior direito da página, clique em Create API.
Configure as informações básicas da API.
Defina as informações básicas, incluindo grupo de APIs, nome, método de autenticação, tipo e descrição. Neste exemplo, o parâmetro Group está definido como o grupo de APIs criado e o parâmetro AppCode Authentication está definido como Enable AppCode Authentication (Header & Query). Configure os demais parâmetros conforme necessário e clique em Next.
Configure as informações de solicitação da API.
Defina como um cliente (como navegador, aplicativo móvel ou sistema corporativo) envia solicitações para a API. Especifique Request Type, Protocol, Request Path, HTTP Method, Request Mode e os parâmetros de solicitação; em seguida, clique em Next. Neste exemplo, o parâmetro Request Mode está definido como Pass-through. Isso significa que o API Gateway encaminha as solicitações diretamente ao EventBridge sem processá-las.
Configure as informações do serviço de backend da API.
Defina o tipo de serviço de backend, URL e mapeamento de parâmetros. Neste exemplo, Use Existing Backend Service está selecionado em Configuration Mode, EventBridge está selecionado em Backend Service Type, e o serviço de backend criado está selecionado na lista suspensa Backend Service. Clique em Next.
Ao criar uma API com EventBridge como serviço de backend, só é possível selecionar um serviço de backend existente. Não é permitido personalizar o serviço de backend.
Defina as respostas da API.
Configure as informações de resposta para gerar documentação que ajude os consumidores a entender a API. É possível definir exemplos de resposta de sucesso e de falha. Neste exemplo, esta etapa foi ignorada. Clique em Create.
Publique a API.
As configurações da API entram em vigor somente após a publicação em um ambiente. Como o serviço de backend foi configurado apenas no ambiente Production neste exemplo, a API só pode ser publicada nesse ambiente. Para publicar em outro ambiente, configure primeiro o serviço de backend correspondente. Clique em Publish na mensagem de confirmação de criação da API e siga as instruções na tela para publicá-la no ambiente Production.
Etapa 4: Criar um aplicativo e conceder permissões para chamar a API
Um aplicativo funciona como identidade para chamadas de API. Como o parâmetro Security Authentication foi definido como Alibaba Cloud App durante a criação da API, crie um aplicativo e autorize-o a realizar chamadas.
Crie um aplicativo.
No painel de navegação à esquerda do console do API Gateway, escolha Call APIs-Apps para criar um aplicativo. O método de autenticação Alibaba Cloud App suporta dois modos: par AppKey/AppSecret e AppCode. Neste exemplo, utiliza-se AppCode. Para mais informações, consulte Autorização de API.
Conceda ao aplicativo permissões para chamar a API.
Na página APIs, localize a API criada e clique em Authorize na coluna Actions. Defina o parâmetro Stage como o ambiente onde a API foi publicada. Neste exemplo, Stage está definido como Production. Insira o nome do aplicativo criado na caixa de pesquisa da seção Choose Apps for Authorization. Nos resultados, selecione o aplicativo desejado, clique em Add na coluna Actions e confirme. Uma mensagem indicará que o aplicativo foi autorizado a chamar a API.
Etapa 5: Depurar a API
O API Gateway oferece depuração online. Utilize esse recurso para validar se a API está configurada corretamente antes de chamá-la a partir de clientes.
Na página APIs, clique no nome da API criada. Na página de detalhes da API, clique em Debug API na árvore de navegação à esquerda. Caso tenha definido parâmetros de solicitação, insira valores diferentes para verificar se a API funciona conforme esperado.
Durante a depuração, certifique-se de que o parâmetro App Name corresponda ao aplicativo autorizado e que o ambiente de depuração seja o mesmo onde a autorização foi concedida. Caso contrário, a depuração poderá falhar. Neste exemplo, Production está selecionado.
Após o sucesso da depuração, consulte os detalhes do evento no barramento de eventos usando o ID do evento retornado.
Etapa 6: Chamar a API
Neste ponto, a API já foi criada e publicada, o aplicativo foi criado e autorizado, e a depuração foi concluída. Agora é possível chamar a API a partir do seu sistema corporativo usando o AppCode.
Para mais informações sobre como chamar a API, consulte Chamar uma API usando autenticação simples (AppCode).