Ler em inglês

Compartilhar via

O que é o Gerenciamento de API do Azure?

  • Artigo

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.

Diagrama mostrando a função das APIs nas experiências conectadas.

O Gerenciamento de API do Azure ajuda as organizações a enfrentar estes desafios:

  • Forneça uma plataforma de API abrangente para diferentes stakeholders e equipes produzirem e gerenciarem APIs
  • 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.

Dica

Visite aka.ms/apimlove para obter uma biblioteca de recursos úteis, incluindo vídeos, blogs e histórias de clientes sobre como usar o Gerenciamento de API do Azure.

Componentes do Gerenciamento de API

O Gerenciamento de API do Azure é composto por um gateway de API, um plano de gerenciamento e um portal de desenvolvedor, com recursos projetados para diferentes públicos no ecossistema de API. 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.

Diagrama mostrando os componentes principais do Gerenciamento de API do Azure.

Gateway de API

Todas as solicitações de aplicativos cliente chegam primeiro ao gateway de API (também chamado de plano de dados ou runtime), que os encaminha para os respectivos serviços de back-end. 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:

Gateway auto-hospedado

Com o gateway auto-hospedado, um provedor de API pode 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 as normas e diretrizes locais. O gateway auto-hospedado permite que as organizações com infraestrutura de TI híbrida gerenciem APIs hospedadas localmente e entre nuvens de um único serviço de Gerenciamento de API no 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 (também chamado de painel de controle), que fornece acesso total aos recursos do 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 como desenvolvedores de aplicativos

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.

Captura de tela do portal do desenvolvedor do Gerenciamento de API – modo de administrador.

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 consumidores de API, como desenvolvedores de aplicativos, acessam o portal do desenvolvedor de software livre para descobrir as APIs, integrar 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.)

Usando o portal do desenvolvedor, os consumidores de API 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

Gerenciamento de API federado com workspaces

Para organizações que desejam capacitar equipes descentralizadas a desenvolver e gerenciar suas próprias APIs com as vantagens da governança e descoberta de API centralizadas, o Gerenciamento de API oferece suporte de primeira classe para um modelo federado de gerenciamento de API com workspaces.

No Gerenciamento de API, os workspaces trazem um novo nível de autonomia para as equipes de API de uma organização, permitindo que eles criem, gerenciem e publiquem APIs de maneira mais rápida, confiável, segura e produtiva dentro de um serviço de Gerenciamento de API. Ao fornecer acesso administrativo isolado e runtime de API, os workspaces capacitam as equipes de API, permitindo que a equipe da plataforma de API mantenha a supervisão. Isso inclui o monitoramento central, a imposição de políticas de API e conformidade e a publicação de APIs para descoberta por meio de um portal de desenvolvedor unificado.

Para obter mais informações:

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 oferecem provisionamento e dimensionamento rápidos, incluindo Basic v2 para desenvolvimento e teste, e Standard v2 e Premium v2 para cargas de trabalho de produção. O Standard v2 e o Premium v2 dão suporte à integração de rede virtual para conexão simplificada com back-ends isolados de rede. Premium v2 também dá suporte à injeção de rede virtual para isolamento total do tráfego de rede de e para o gateway.
  • Consumo - um gateway sem servidor para gerenciar APIs que são dimensionadas com base na demanda e nas contas 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:

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:

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 consumidores de API, como desenvolvedores de aplicativos. 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 está pronto para uso pelos consumidores, ele pode ser publicado. Depois de publicado, ele pode ser exibido ou assinado pelos usuários por meio do 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:

Usuários e grupos

Os usuários (consumidores de API) podem ser criados ou convidados a ingressar por administradores de serviços ou podem se inscrever no portal do desenvolvedor. Cada usuário é membro de um ou mais grupos e pode assinar os produtos que concedem visibilidade a esses grupos.

O Gerenciamento de API tem os seguintes grupos integrados:

  • 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 proprietários de serviços de Gerenciamento de API também podem criar grupos personalizados ou usar grupos externos em um locatário associado do Microsoft Entra para dar aos usuários 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:

Workspaces

Os workspaces dão suporte a um modelo federado de gerenciamento de API, permitindo que as equipes de desenvolvimento de API descentralizadas gerenciem e transformem suas próprias APIs em produtos, enquanto uma equipe de plataforma de API central mantém a infraestrutura de 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. Cada workspace é associado a um ou mais gateways de workspace que roteiam o tráfego de API para seus serviços de back-end.

Para obter mais informações:

Políticas

Com políticas, um provedor 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 de texto em muitas das políticas de Gerenciamento de API. 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:

Criar uma instância de serviço do Gerenciamento de API do Azure usando o portal do Azure