Exercício - Criar uma API de back-end
Neste exercício, você aprenderá a executar as seguintes ações:
- Criar uma instância de Gerenciamento de API (APIM)
- Importar uma API
- Definir as configurações de back-end
- Testar a API
Pré-requisitos
- Uma conta do Azure com uma assinatura ativa. Se ainda não tiver uma, pode inscrever-se numa avaliação gratuita em https://azure.com/free.
Iniciar sessão no Azure
Entre no portal do Azure e abra o Cloud Shell.
Depois que o shell abrir, certifique-se de selecionar o ambiente Bash .
Criar uma instância da Gestão de API
Vamos definir algumas variáveis para os comandos da CLI usarem para reduzir a quantidade de redigitação. Substitua
<myLocation>
por uma região que faça sentido para você. O nome APIM precisa ser um nome globalmente exclusivo e o script a seguir gera uma cadeia de caracteres aleatória. Substitua<myEmail>
por um endereço de e-mail que você possa acessar.myApiName=az204-apim-$RANDOM myLocation=<myLocation> myEmail=<myEmail>
Crie um grupo de recursos. Os comandos a seguir criam um grupo de recursos chamado az204-apim-rg.
az group create --name az204-apim-rg --location $myLocation
Crie uma instância do APIM. O
az apim create
comando é usado para criar a instância. A--sku-name Consumption
opção é usada para acelerar o processo para o passo a passo.az apim create -n $myApiName \ --location $myLocation \ --publisher-email $myEmail \ --resource-group az204-apim-rg \ --publisher-name AZ204-APIM-Exercise \ --sku-name Consumption
Nota
A operação deve ser concluída em cerca de cinco minutos.
Importar uma API de back-end
Esta secção mostra como importar e publicar uma API de back-end de especificação de OpenAPI.
No portal do Azure, procure e selecione serviços de Gerenciamento de API.
Na tela Gerenciamento de API, selecione a instância de Gerenciamento de API que você criou.
Selecione APIs no painel de navegação do serviço de gerenciamento de API.
Selecione OpenAPI na lista e selecione Completo no pop-up.
Use os valores da tabela abaixo para preencher o formulário. Você pode deixar qualquer campo não mencionado seu valor padrão.
Definição valor Descrição Especificação de OpenAPI https://conferenceapi.azurewebsites.net?format=json
Faz referência ao serviço que implementa a API, as solicitações são encaminhadas para este endereço. A maioria das informações necessárias no formulário é preenchida automaticamente depois de inseri-lo. Nome a apresentar API da Conferência de Demonstração Este nome é apresentado no portal do Programador. Name demo-conference-api Fornece um nome exclusivo para a API. Descrição Preenchido automaticamente Forneça uma descrição opcional da API. Sufixo do URL da API conferência O sufixo é anexado ao URL base do serviço Gestão de API. A Gestão de API distingue as APIs pelo respetivo sufixo, pelo que cada API tem de ter o seu sufixo exclusivo para um determinado editor. Selecione Criar.
Definir as configurações de back-end
A API de conferência de demonstração é criada e um back-end precisa ser especificado.
Selecione Configurações na folha à direita e insira
https://conferenceapi.azurewebsites.net/
o campo URL do serviço Web.Desmarque a caixa de seleção Assinatura necessária .
Selecione Guardar.
Testar a API
Agora que a API foi importada e o back-end configurado, é hora de testar a API.
Selecione Teste.
Selecione GetSpeakers. A página mostra parâmetros de consulta e cabeçalhos, se houver. O
Ocp-Apim-Subscription-Key
é preenchido automaticamente para a chave de assinatura associada a esta API.Selecione Enviar.
O back-end responde com 200 OK e alguns dados.
Limpar recursos do Azure
Quando terminar os recursos criados neste exercício, você poderá usar o comando abaixo para excluir o grupo de recursos e todos os recursos relacionados.
az group delete --name az204-apim-rg