Importar e publicar uma API
Para disponibilizar uma API usando um gateway de API, você precisará importar e publicar a API.
No exemplo de empresa de calçados, a NorthWind Shoes deseja permitir que parceiros selecionados sejam capazes de consultar os níveis de estoque e de inventário.
Aqui, você aprenderá a importar uma API para o Gerenciamento de API do Azure e a disponibilizar uma API para os clientes.
API
Uma API é uma maneira padronizada pela qual as organizações expõem dados específicos a potencial desenvolvedores ou parceiros. Por exemplo, no exercício anterior, você criou uma API para compartilhar informações sobre produtos e inventário.
A disponibilização de uma API começa com sua importação para o Gerenciamento de API. Em seguida, você pode:
- Teste sua API usando as ferramentas de visualização no gateway de API.
- Gerenciar o acesso a suas APIs usando políticas.
Estruturas de API
Há várias estruturas e padrões de API. O Gerenciamento de API oferece 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, você especifica 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 de GraphQL sintética com resolvedores de campo personalizados. |
| OpenAPI | OpenAPI é uma especificação que documenta todos os pontos de extremidade e as operações das APIs RESTful e todos os parâmetros de entrada e saída. A OpenAPI tinha o nome de Swagger. |
| WADL | A linguagem WADL é uma descrição XML de serviços Web baseados em HTTP. É um formato mais simples e mais leve que a WSDL. |
| WSDL | Web Service Description Language é uma descrição XML de qualquer serviço de rede, não apenas HTTP. |
Você também pode importar APIs de vários recursos do Azure de back-end. As opções incluem as da tabela a seguir.
| Type | Detalhes |
|---|---|
| Serviço OpenAI do Azure | APIs que fornecem acesso aos modelos de linguagem da OpenAI para tarefas como geração de conteúdo, resumo, pesquisa semântica e muito mais. |
| Aplicativo Lógico | Aplicativos lógicos são usados para orquestrar e automatizar fluxos de trabalho e integrações com várias fontes de dados. |
| Serviço de Aplicativo | Uma API hospedada dentro de um serviço de aplicativo no Azure. |
| Aplicativo de Funções | Código sem servidor que pode ser chamado por meio de gatilhos. |
| Aplicativo de contêiner | Contêineres sem servidor para microsserviços. |
Importar uma API
Há várias maneiras de importar uma API para o Gerenciamento de API do Azure.
Usando o portal do Azure, selecione APIs e, em seguida, + Adicionar API. Comece selecionando o tipo de API que você deseja importar.
Em seguida, você fornece um link para sua especificação de API como uma URL ou arquivo, bem como um nome para a API. Veja um exemplo de importação de OpenAPI.
O portal do Azure não é a ferramenta mais eficiente para importar e configurar grandes números de APIs. Ao escalar verticalmente o gerenciamento de API, você precisará de outras ferramentas, como a CLI do Azure, modelos do Azure Resource Manager ou do 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.
Visualizar
Você pode usar o gateway de API como uma maneira de visualizar como os dados são processados por meio de suas APIs importadas. Você pode interagir com conjuntos de dados e passar parâmetros por meio de suas APIs.
Se for um administrador, você poderá visualizar APIs no portal do Azure.
Políticas
As políticas fornecem recursos avançados para alterar o comportamento de uma API por meio da configuração. Elas existem como um conjunto de instruções executadas em sequência, na solicitação ou na resposta de uma API.
Configurações populares incluem:
- Conversão de XML para JSON
- Limitação de fluxo de chamadas para restringir o número de chamadas recebidas.
- Configuração de cabeçalhos de entrada e de saída.
Use o portal do Azure para aplicar diferentes políticas às APIs. As políticas podem ser exibidas na guia Design.
Você também pode usar a guia Design para adicionar novas políticas.
Produto
Um produto é uma coleção de APIs. Você pode atribuir APIs a mais de um produto. Por exemplo, você pode querer que um produto, NorthWindShoesPartners, exponha duas APIs para seus parceiros:
| Produto | NorthWindShoesPartners |
|---|---|
| API 1 | Inventário |
| API 2 | Planejamento |
Para seus fornecedores, talvez você queira expor apenas uma API:
| Produto | NorthWindShoesSuppliers |
|---|---|
| API 1 | Inventário |
| API 2 |
Você atribui políticas para que seus produtos possam ter diferentes regras de acesso, cotas de uso e termos de uso. Portanto, se quiser que seus parceiros e fornecedores tenham diferentes direitos de acesso a sua API de Inventário, atribua a API a dois produtos diferentes.
Você pode usar o portal do Azure para associar APIs a um produto.
Em vários níveis de preços, há dois produtos padrão: Starter e Unlimited. O produto Unlimited foi projetado para o gerenciamento de API de produção, pois não tem nenhuma restrição quanto ao número de APIs anexadas. Você pode criar quantos novos produtos quiser. O produto Starter tem um limite de cinco chamadas à API/minuto e um máximo de 100 chamadas à API/semana.