Gerenciamento de API e excelência operacional
Saiba mais sobre como usar o Gerenciamento de API para publicar APIs para desenvolvedores externos, parceiros e funcionários com segurança e em grande escala. Esse serviço de rede é uma plataforma híbrida de gerenciamento de várias nuvens para APIs em todos os ambientes.
Os componentes incluem:
Para obter mais informações, consulte Sobre o Gerenciamento de API.
Para entender como o Gerenciamento de API permite excelência operacional, consulte os tópicos a seguir:
- Gerenciando o Gerenciamento de API do Azure usando a Automação do Azure
- Observabilidade no Gerenciamento de API do Azure
Lista de verificação
Você configurou o Gerenciamento de API pensando na excelência operacional?
- Proteja a comunicação entre o Gerenciamento de API e o back-end.
- Verifique se cada parte tem sua própria credencial ao expor APIs a terceiros.
- Defina cotas e limites de taxa ao expor APIs a terceiros.
- Entenda as diretrizes de arquitetura e design de API REST da Microsoft.
- Habilite o controle de versão das APIs para manter a compatibilidade com versões anteriores ao adicionar outros recursos.
- Use os recursos de controle de versão e revisões de Gerenciamento de API para implementar o controle de versão da API.
- Entenda as restrições de importação de API no Gerenciamento de API.
- Entenda o recurso de registro em log de eventos.
- Rastreie chamadas no Gerenciamento de API do Azure para ajudar com a depuração e o teste.
- Configure o registro em log usando o Azure Monitor para o serviço de Gerenciamento de API.
- Escolha os modos certos para acessar conexões privadas de site.
- Avalie as regras de firewall e as lista de IPs permitidos com base no IP de Gerenciamento de API.
Recomendações de configuração
Considere as seguintes recomendações de excelência operacional ao configurar o serviço de Gerenciamento de API:
| Recomendação | Descrição |
|---|---|
| Defina cotas e limites de taxa ao expor APIs a terceiros. | Proteja os serviços de back-back e reduza a carga colocada em uma unidade de escala do Gerenciamento de API. As políticas de limitação de taxa podem ser aplicadas nos níveis Global, Produto, API e Operação para oferecer personalização de limite de taxa aplicada aos consumidores de API. |
| Entenda as diretrizes de arquitetura e design de API REST da Microsoft. | Siga os padrões e as práticas recomendadas ao usar a API REST. As práticas recomendadas a seguir permitem a compatibilidade máxima entre plataformas e implementações. Revise as Diretrizes da API REST e as diretrizes de Design de API. |
| Entenda as restrições de importação de API no Gerenciamento de API. | Todos os esforços são feitos para garantir que o processo de importação de API seja executado sem problemas, o que inclui não exigir personalização. Alguns cenários impõem restrições que exigirão modificação na origem da importação. Aplica-se aos serviços REST e SOAP. Consulte Restrições de Política para obter as restrições atuais de Importação de API. |
| Entenda o recurso de registro em log de eventos. | Dá suporte ao registro em log de eventos em um hub de eventos do Azure para executar uma análise quase em tempo real. Esse recurso integra-se a registros em log externos, soluções de SIEM (Gerenciamento de eventos e informações de segurança) ou análise do uso da API quase em tempo real. |
| Rastreie chamadas no Gerenciamento de API do Azure para ajudar com a depuração e o teste. | O rastreamento deve ser habilitado na assinatura usada para fazer a solicitação. O rastreamento é habilitado por solicitação usando o valor do cabeçalho Ocp-Apim-Trace. O Rastreamento de API também é integrado ao portal do administrador e é habilitado por padrão ao testar APIs do portal. |
| Configure o registro em log usando o Azure Monitor para o serviço de Gerenciamento de API. | Os registros podem ser enviados para um workspace do Logs Analytics para habilitar consultas e análises complexas. As métricas podem ser ingeridas para análise de longo prazo. Em seguida, todos os dados são apresentados usando o Azure Monitor. É possível integrar o Application Insights para gerenciamento de desempenho de aplicativos. |
| Escolha os modos certos para acessar conexões privadas de site. | Dá suporte à integração de Rede Virtual no modo interno e externo. |
| Avalie as regras de firewall e as lista de IPs permitidos com base no IP de Gerenciamento de API. | Um IP fixo está disponível durante o tempo de vida do serviço com os planos Básico, Desenvolvedor, Standard e Premium para Gerenciamento de API. |