Importar e publicar uma API
Para disponibilizar uma API através de um gateway de API, tem de importar e publicar a API.
No exemplo da empresa de calçado, a NorthWind Shoes quer permitir que parceiros selecionados possam consultar o inventário e os níveis de stock.
Aqui, você aprenderá como importar uma API para o Gerenciamento de API do Azure e como disponibilizar uma API para clientes.
API
Uma API é uma forma normalizada de as organizações exporem dados específicos a programadores ou parceiros potenciais. Por exemplo, no exercício anterior, criou uma API para partilhar informações sobre o inventário e produtos.
A disponibilização de uma API começa com a importação da API para a Gestão de API. Em seguida, pode:
- Teste sua API usando as ferramentas de visualização no gateway de API.
- Gerir o acesso às suas APIs através de políticas.
Arquiteturas de API
Existem vários padrões e arquiteturas de API. A Gestão de API fornece várias opções para importar APIs. Incluindo as opções na tabela a seguir:
| Type | Detalhes |
|---|---|
| HTTP | Você pode importar uma API HTTP com uma definição de API em branco. Em seguida, pode especificar manualmente todos os parâmetros necessários. |
| WebSocket | Configure a passagem para um serviço WebSocket de back-end. |
| GraphQL | Configure a passagem para um serviço GraphQL de back-end ou importe um esquema GraphQL e crie uma API GraphQL sintética com resolvedores de campo personalizados. |
| OpenAPI | OpenAPI é uma especificação que documenta todos os endpoints e operações para APIs RESTful e todos os parâmetros de entrada e saída. O OpenAPI chamava-se originalmente Swagger. |
| WADL | O Web Application Description Language é uma descrição XML de serviços Web baseados em HTTP. É um formato mais simples e mais leve do que o Web Service Description Language. |
| WSDL | O Web Service Description Language é uma descrição XML de qualquer serviço de rede e não apenas HTTP. |
Você também pode importar APIs de vários recursos de back-end do Azure. As opções incluem as da tabela a seguir.
| Type | Detalhes |
|---|---|
| Azure OpenAI Service | APIs que fornecem acesso aos modelos de linguagem da OpenAI para tarefas que incluem geração de conteúdo, sumarização, pesquisa semântica e muito mais. |
| Aplicação Lógica | As aplicações lógicas são utilizadas para orquestrar e automatizar fluxos de trabalho e integrações com várias origens de dados. |
| Serviço de Aplicações | Uma API hospedada em um serviço de aplicativo no Azure. |
| Aplicação de Funções | Código sem servidor que pode ser chamado através de acionadores. |
| Aplicativo de contêiner | Contêineres sem servidor para microsserviços. |
Importar uma API
Existem várias formas de importar uma API para a Gestão de API do Azure.
No portal do Azure, selecione APIs e + Adicionar API. Você começa selecionando o tipo de API que deseja importar.
Em seguida, forneça uma ligação para a especificação de API sob a forma de um URL ou ficheiro, e um nome para a API. Eis um exemplo de uma importação de OpenAPI.
O portal do Azure não é a ferramenta mais eficiente para importar e configurar um grande número de APIs. À medida que aumenta a escala do gerenciamento de API, você precisa de outras ferramentas, como a CLI do Azure, o Gerenciador de Recursos do Azure ou os modelos Bicep ou o Azure PowerShell. Por exemplo, você pode usar cmdlets do Azure PowerShell para implantar gateways de API, definir e configurar produtos, importar APIs e gerenciar usuários e assinaturas.
Visualização
Pode utilizar o gateway de API como um meio para visualizar a forma como os dados são processados através das APIs importadas. Pode interagir com conjuntos de dados e transmitir parâmetros através das suas APIs.
Se você for um administrador, poderá visualizar APIs no portal do Azure.
Políticas
As políticas disponibilizam funcionalidades avançadas para alterar o comportamento de uma API através da configuração. As políticas têm a forma de uma coleção de instruções executadas sequencialmente no pedido ou na resposta de uma API.
Seguem-se algumas configurações populares:
- Conversão de XML em JSON
- Limitação da frequência de chamadas para restringir o número de chamadas recebidas.
- Definição de cabeçalhos de entrada e saída.
Utilize o portal do Azure para aplicar diferentes políticas a APIs. Pode ver as políticas no separador Estrutura.
Você também pode usar a guia Design para adicionar novas políticas.
Produto
Um produto é uma coleção de APIs. Pode atribuir APIs a mais do que um produto. Por exemplo, poderá querer que o produto NorthWindShoesPartners exponha duas APIs aos seus parceiros:
| Produto | NorthWindShoesPartners |
|---|---|
| API 1 | Inventário |
| API 2 | Planeamento |
Para os seus fornecedores, poderá querer expor só uma API:
| Produto | NorthWindShoesSuppliers |
|---|---|
| API 1 | Inventário |
| API 2 |
Atribua políticas de forma que os seus produtos possam ter regras de acesso, quotas de utilização e termos de utilização diferentes. Assim, se quiser que os seus parceiros e fornecedores tenham direitos de acesso diferentes à sua API Inventário, atribua a API a dois produtos diferentes.
Utilize o portal do Azure para associar APIs a um produto.
Em vários níveis de preços, existem dois produtos padrão: Starter e Unlimited. O produto Unlimited (Ilimitado) destina-se à gestão de API de produção, uma vez que não tem restrições quanto ao número de APIs anexadas. Pode criar tantos novos produtos quanto necessário. O produto Starter tem um limite de cinco chamadas de API/minuto e um máximo de 100 chamadas de API/semana.