O que é o Gerenciamento de API do Azure?
APLICA-SE A: todas as camadas do Gerenciamento de API
Este artigo fornece uma visão geral dos cenários comuns e dos principais componentes de Gerenciamento de API do Azure. O Gerenciamento de API do Azure é uma plataforma híbrida de gerenciamento de várias nuvens para APIs em todos os ambientes. Como plataforma como serviço, o Gerenciamento de API dá suporte ao ciclo de vida completo da API.
Dica
Se você já estiver familiarizado com o Gerenciamento de API e pronto para começar, consulte estes recursos:
Cenários
As APIs permitem experiências digitais, simplificam a integração de aplicativos, fundamentam novos produtos digitais e possibilitam a reutilização de dados e serviços e podem ser universalmente acessíveis. Com a proliferação e a dependência crescente de APIs, as organizações precisam gerenciá-las como ativos de primeira classe em todo o ciclo de vida.
O Gerenciamento de API do Azure ajuda os clientes a enfrentar estes desafios:
- Diversidade e complexidade da arquitetura de back-end abstrata de consumidores de API
- Expor com segurança os serviços hospedados dentro e fora do Azure como APIs
- Proteger, acelerar e observar APIs
- Habilitar a descoberta e o consumo de API por usuários internos e externos
Cenários comuns incluem:
- Desbloqueando ativos herdados – as APIs são usadas para abstração e modernização de back-backs herdados e torná-los acessíveis de novos serviços de nuvem e aplicativos modernos. As APIs permitem a inovação sem o risco, o custo e os atrasos da migração.
- Integração de aplicativo centrado em API – as APIs são mecanismos facilmente consumíveis, baseados em padrões e autodescritivos para expor e acessar dados, aplicativos e processos. Eles simplificam e reduzem o custo da integração de aplicativos.
- Experiências de usuário de vários canais – as APIs são frequentemente usadas para habilitar experiências do usuário, como aplicativos Web, móveis, acessórios ou Internet das Coisas. Reutilizar APIs para acelerar o desenvolvimento e o ROI.
- Integração B2B – APIs expostas a parceiros e clientes rebaixam a barreira para integrar processos de negócios e trocar dados entre entidades de negócios. As APIs eliminam a sobrecarga inerente na integração ponto a ponto. Especialmente com a descoberta e a integração de autoatendimento habilitadas, as APIs são as principais ferramentas para dimensionar a integração B2B.
Componentes do Gerenciamento de API
O Gerenciamento de API do Azure é composto por um gateway de API, um plano de gerenciamento e um portal do desenvolvedor. Esses componentes são hospedados no Azure e totalmente gerenciados por padrão. O Gerenciamento de API está disponível em várias camadas diferentes na capacidade e nos recursos.
Gateway de API
Todas as solicitações de aplicativos cliente primeiro chegam ao gateway de API, que as encaminha para os respectivos serviços de back-back. O gateway de API atua como uma fachada para os serviços de back-end, permitindo que os provedores de API abstraiam implementações de API e desenvolvam a arquitetura de back-end sem afetar os consumidores de API. O gateway permite uma configuração consistente de roteamento, segurança, limitação, cache e observabilidade.
Especificamente, o gateway:
- Atua como uma fachada para serviços de back-end aceitando chamadas à API e roteando-as para back-ends apropriados
- Verifica as chaves de API e outras credenciais, como tokens JWT e certificados apresentados com solicitações
- Impõe cotas de uso e limites de taxa
- Opcionalmente, transforma solicitações e respostas conforme especificado em instruções de política
- Se configurado, armazena em cache as respostas para aprimorar a latência de resposta e minimizar a carga nos serviços de back-end
- Emite logs, métricas e rastreamentos para monitoramento, relatórios e solução de problemas
Gateway auto-hospedado
Com o gateway auto-hospedado, os clientes podem implantar o gateway de API nos mesmos ambientes em que hospedam suas APIs, para otimizar o tráfego de API e garantir a conformidade com regulamentos e diretrizes locais. O gateway auto-hospedado permite que os clientes com infraestrutura de TI híbrida gerenciem APIs hospedadas localmente e entre nuvens de um único serviço de Gerenciamento de API do Azure.
O gateway auto-hospedado é empacotado como um contêiner do Docker baseado em Linux e normalmente é implantado no Kubernetes, incluindo no Serviço de Kubernetes do Azure e Kubernetes habilitados para Azure Arc.
Mais informações:
Plano de gerenciamento
Os provedores de API interagem com o serviço por meio do plano de gerenciamento, que fornece acesso completo às funcionalidades de serviço de Gerenciamento de API.
Os clientes interagem com o plano de gerenciamento por meio de ferramentas do Azure, incluindo o portal do Azure, Azure PowerShell, CLI do Azure, uma extensão do Visual Studio Code, uma API REST ou SDKs de cliente em várias linguagens de programação populares.
Use o plano de gerenciamento para:
- Provisionar e definir o Gerenciamento de API de configurações de serviço
- Defina ou importe esquemas de API de uma ampla variedade de fontes, incluindo definições OpenAPI, WSDL e OData, serviços de computação do Azure e back-ends WebSocket, GraphQL e gRPC
- Empacotar APIs em produtos
- Políticas de configuração como cotas ou transformações em APIs
- Obter insights por meio de análises
- Gerenciar usuários
Portal do desenvolvedor
O portal do desenvolvedor de código aberto é um site gerado de modo automático e totalmente personalizável com a documentação das suas APIs.
Os provedores de API podem personalizar a aparência do portal do desenvolvedor adicionando conteúdo personalizado, personalização de estilo e adicionando a marca deles. Estenda o portal do desenvolvedor ainda mais por auto-hospedagem.
Os desenvolvedores de aplicativos usam o portal do desenvolvedor de software livre para descobrir as APIs, integração para usá-las e aprender a consumi-las em aplicativos. (As APIs também podem ser exportadas para o Power Platform para descoberta e uso por desenvolvedores cidadãos.)
Ao usar o portal do desenvolvedor, os desenvolvedores podem:
- Ler a documentação da API
- Experimentar uma API por meio do console interativo
- Criar uma conta e fazer uma assinatura para obter chaves de API
- Acessar a análise do seu próprio uso.
- Baixar definições de API
- Gerenciar chaves de API
Camadas do Gerenciamento de API
O Gerenciamento de API é oferecido em uma variedade de tipos de preços para atender às necessidades de diferentes clientes. Cada camada oferece uma combinação distinta de recursos, desempenho, limites de capacidade, escalabilidade, SLA e preços para diferentes cenários. As camadas são agrupadas da seguinte maneira:
- Clássico: A oferta original do Gerenciamento de API, incluindo as camadas Desenvolvedor, Básico, Standard e Premium. A camada Premium foi projetada para empresas que exigem acesso a back-ends privados, recursos de segurança aprimorados, implantações em várias regiões, zonas de disponibilidade e alta escalabilidade. A camada Desenvolvedor é uma opção econômica para uso sem produção, enquanto as camadas Básico, Standard e Premium são camadas prontas para produção.
- V2 - Um novo conjunto de camadas que oferece provisionamento e dimensionamento rápidos, incluindo a Básico v2 para desenvolvimento e teste, e a Standard v2 para cargas de trabalho de produção. A Standard v2 dá suporte à conexão simplificada com back-ends isolados da rede.
- Consumo: A camada de consumo é um gateway sem servidor para gerenciar APIs que são dimensionadas com base na demanda e cobradas por execução. Ela foi projetada para aplicativos com computação sem servidor, arquiteturas baseadas em microsserviços e aqueles com padrões de tráfego variáveis.
Para obter mais informações:
- Comparação baseada em recursos dos níveis de gerenciamento de API do Azure
- Camadas de serviço V2
- Preços de Gerenciamento de API
Integração com serviços do Azure
O Gerenciamento de API integra-se a muitos serviços complementares do Azure para criar soluções empresariais, incluindo:
- Azure Key Vault para segurança e gerenciamento de certificados do cliente e segredos
- Azure Monitor para registro em log, relatórios e alertas sobre operações de gerenciamento, eventos de sistemas e solicitações de API
- Application Insights para métricas ao vivo, rastreamento de ponta a ponta e solução de problemas
- Redes virtuais, pontos de extremidade privados e Gateway de Aplicativo para proteção em nível de dados
- Azure Defender para APIs e Proteção contra DDoS do Azure para proteção de runtime contra ataques mal-intencionados
- ID do Microsoft Entra para autenticação de desenvolvedor e autorização de solicitação
- Hubs de eventos para eventos de streaming
- Várias ofertas de computação do Azure normalmente usadas para criar e hospedar APIs no Azure, incluindo Funções, Aplicativos Lógicos, Aplicativos Web, Service Fabric e outros, incluindo o serviço OpenAI do Azure.
Para obter mais informações:
Principais conceitos
APIs
As APIs são a fundação de uma instância de serviço de Gerenciamento de API. Cada API representa um conjunto de operações disponíveis para desenvolvedores. Cada API contém uma referência para serviço back-end que implementa a API, e suas operações são mapeadas para as operações de back-end.
As operações no Gerenciamento de API são altamente configuráveis, com controle sobre o mapeamento de URL, parâmetros de consulta e caminho, conteúdo de solicitação e resposta e caching de resposta de operação.
Mais informações:
Produtos
Os produtos são como as APIs são exibidas para os desenvolvedores. Produtos de Gerenciamento de API têm um ou mais APIs e podem ser abertos ou protegidos. Os produtos protegidos exigem uma chave de assinatura, enquanto os produtos abertos podem ser consumidos livremente.
Quando um produto fica pronto para uso pelo desenvolvedor ele pode ser publicado. Depois de publicado, ele pode ser exibido ou assinado por desenvolvedores usando o portal do desenvolvedor. A aprovação de assinatura é configurada no nível do produto e pode requerer a aprovação do administrador ou ser aprovada automaticamente.
Mais informações:
Grupos
Os grupos são usados para gerenciar a visibilidade dos produtos para os desenvolvedores. O Gerenciamento de API tem os seguintes grupos integrados:
Administradores – Gerenciam instâncias de serviço de Gerenciamento de API e criam as APIs, operações e produtos que são usados pelos desenvolvedores.
Os administradores de assinatura do Azure são membros desse grupo.
Desenvolvedores – usuários autenticados do portal do desenvolvedor que cria aplicativos usando suas APIs. Os desenvolvedores têm acesso ao portal do desenvolvedor e criam aplicativos que chamam as operações de uma API.
Convidados – Os usuários não autenticados no portal do desenvolvedor, tais como potenciais clientes visitando o portal do desenvolvedor. Eles podem receber certos acessos somente leitura, como a capacidade de exibir APIs, mas não de chamá-las.
Os administradores também podem criar grupos personalizados ou usar grupos externos em um locatário associado do Microsoft Entra para dar aos desenvolvedores visibilidade e acesso a produtos de API. Por exemplo, crie um grupo personalizado para que os desenvolvedores em uma organização parceira acessem um subconjunto específico de APIs em um produto. Um usuário pode pertencer a mais de um grupo.
Mais informações:
Desenvolvedores
Os desenvolvedores representam as contas de usuários em uma instância de serviço de Gerenciamento de API. Os desenvolvedores podem ser criados ou convidados para se juntarem aos administradores ou podem fazer a inscrição no portal do desenvolvedor. Cada desenvolvedor é um membro de um ou mais grupos, e pode assinar produtos que dão visibilidade a esses grupos.
Quando os desenvolvedores assinam um produto, recebem as chaves principal e secundária para esse produto, a serem usadas ao chamar as APIs do produto.
Mais informações:
Workspaces
Os workspaces permitem que as equipes de desenvolvimento de API descentralizadas gerenciem e produzam suas próprias APIs, enquanto uma equipe central da plataforma de API mantém a infraestrutura do Gerenciamento de API. Cada workspace contém APIs, produtos, assinaturas e entidades relacionadas que são acessíveis somente aos colaboradores do workspace. O acesso é controlado por meio do RBAC (controle de acesso baseado em função) do Azure.
Para obter mais informações:
Políticas
Com as políticas, um editor de API pode alterar o comportamento de uma API por meio da configuração. As políticas são um conjunto de instruções executadas em sequência, na solicitação ou na resposta de uma API. Instruções populares incluem a conversão do formato de XML para JSON e limite de taxa de chamada para restringir o número de chamadas recebidas de um desenvolvedor. Para obter uma lista completa, consulte Políticas de Gerenciamento de API.
Expressões de política podem ser usadas como valores de atributo ou texto em qualquer uma das políticas de Gerenciamento de API, a menos que a política especifique o contrário. Algumas políticas, como Controlar fluxo e Definir variável se baseiam em expressões de políticas.
As políticas podem ser aplicadas em escopos diferentes, dependendo de suas necessidades: global (todas as APIs), um produto, uma API específica ou uma operação de API.
Para obter mais informações:
Próximas etapas
Conclua o seguinte guia de início rápido e comece a usar o Gerenciamento de API do Azure: