Gestão de API e excelência operacional
Saiba como utilizar Gestão de API para publicar APIs em programadores externos, parceiros e colaboradores de forma segura e em escala. Este serviço de rede é uma plataforma de gestão híbrida e multicloud para APIs em todos os ambientes.
Os componentes incluem:
Para obter mais informações, veja Acerca de Gestão de API.
Para compreender como Gestão de API suporta a excelência operacional, veja os seguintes tópicos:
Lista de Verificação
Configurou Gestão de API com excelência operacional em mente?
- Proteja a comunicação entre o Gestão de API e o back-end.
- Certifique-se de que cada parte tem a sua própria credencial ao expor APIs a terceiros.
- Certifique-se de que define quotas e limites de taxa ao expor APIs a terceiros.
- Compreenda a documentação de orientação de arquitetura e estrutura da API REST da Microsoft.
- Ative o controlo de versões de APIs para manter a retrocompatibilidade ao adicionar outras funcionalidades.
- Utilize as funcionalidades de Controlo de Versões e Revisões do Gestão de API para implementar o controlo de versões da API.
- Compreenda as restrições de importação de API no Gestão de API.
- Compreenda a funcionalidade Registo de eventos.
- As chamadas de rastreio no Azure Gestão de API para ajudar na depuração e teste.
- Configure o registo com o Azure Monitor para o serviço Gestão de API.
- Selecione os modos certos para aceder às ligações de sites privados.
- Avalie as regras de firewall e as listas de permissões de IP com base no endereço IP público Gestão de API.
Recomendações de configuração
Considere as seguintes recomendações de excelência operacional ao configurar o serviço de Gestão de API:
| Recomendação | Description |
|---|---|
| Certifique-se de que define quotas e limites de taxa ao expor APIs a terceiros. | Proteja os serviços de back-end e reduza a carga colocada numa unidade de dimensionamento Gestão de API. As políticas de limitação de taxas podem ser aplicadas aos níveis Global, Produto, API e Operação para fornecer personalização de limite de taxa aplicada aos consumidores de API. |
| Compreenda a documentação de orientação de arquitetura e estrutura da API REST da Microsoft. | Siga as normas e as melhores práticas ao utilizar a API REST. As melhores práticas seguintes permitem a compatibilidade máxima entre plataformas e implementações. Reveja as Diretrizes da API REST e a documentação de orientação da Estrutura da API. |
| Compreenda as restrições de importação de API no Gestão de API. | São feitos todos os esforços para garantir que o processo de importação da API é executado sem problemas, o que inclui não exigir personalizações. Alguns cenários impõem restrições que exigirão a modificação da origem de importação. Aplica-se aos serviços REST e SOAP. Restrições de Política de Referência para as restrições de Importação de API atuais. |
| Compreenda a funcionalidade Registo de eventos. | Suporta o registo de eventos num hub de eventos do Azure para realizar análises quase em tempo real. Esta funcionalidade integra-se com o registo externo, as informações de segurança e as soluções de gestão de eventos (SIEM) ou a análise da utilização da API quase em tempo real. |
| As chamadas de rastreio no Azure Gestão de API para ajudar na depuração e teste. | O rastreio tem de estar ativado na subscrição utilizada para fazer o pedido. O rastreio é ativado numa base de pedido a pedido com o valor do cabeçalho Ocp-Apim-Trace . O Rastreio de API também está incorporado no portal de administração e está ativado por predefinição ao testar APIs a partir do portal. |
| Configure o registo com o Azure Monitor para o serviço Gestão de API. | Os registos podem ser enviados para uma área de trabalho do Logs Analytics para permitir consultas e análises complexas. As métricas podem ser ingeridas para análise a longo prazo. Em seguida, todos os dados são apresentados com o Azure Monitor. É possível integrar o Application Insights para a Gestão de Desempenho de Aplicações. |
| Selecione os modos certos para aceder às ligações de sites privados. | Suporta Rede Virtual integração no modo interno e externo. |
| Avalie as regras de firewall e as listas de permissões de IP com base no endereço IP público Gestão de API. | Está disponível um endereço IP público fixo para a duração do serviço com os planos Básico, Programador, Standard e Premium para Gestão de API. |