O que é o Centro de API do Azure?
O Centro de API do Azure é um novo serviço no Azure que oferece um repositório estruturado e centralizado de todas as APIs organizacionais, habilitando acompanhamento, descoberta, reutilização e governança unificados. O Centro de API é uma solução segura que consolida e organiza todas as suas APIs independentemente do tipo, estágio do ciclo de vida de desenvolvimento ou local de implantação para o runtime da API, juntamente com quaisquer metadados ou informações relacionadas à API.
Benefícios do Centro de API
| Problema do cliente | Benefícios do Centro de API |
|---|---|
| Baixa capacidade de descoberta e reutilização da API | Facilidade de descoberta e consumo de API. Os gerentes de API podem exibir um inventário completo de todas as APIs no portal do Azure. Os consumidores de API podem usar o portal do Centro de API baseado na Web para descobrir e consumir APIs ou usar a extensão do Centro de API para Visual Studio Code para criar, descobrir e consumir APIs. |
| Sombra, APIs desgovernadas | Inventário centralizado de APIs. O Centro de API permite que as organizações criem um repositório central de APIs de diferentes equipes e departamentos que atuam como uma fonte consolidada de verdade e confiança para todas as APIs. |
| Possíveis ameaças à segurança | Facilidade de governança de API. Com as APIs consolidadas em um único local, controlar essas APIs para impor políticas de segurança da organização torna-se mais fácil para as equipes da Plataforma de API. |
| Design de API inconsistente | Verificações de conformidade de design de API automatizadas. O Centro de API permite que os administradores imponham padrões de design em todas as APIs e implementem um fluxo de trabalho de lint que verifica APIs em um guia de estilo definido e gera um relatório de conformidade de API acessível em seu Centro de API. |
Funções e responsabilidades do ecossistema de API
O ecossistema de API de uma organização geralmente consiste em diferentes funções com diversas responsabilidades que são parte integrante de sua operação bem-sucedida. Vamos dar uma olhada mais de perto em algumas das funções.
Produtores de API – podem ser desenvolvedores individuais ou equipes cujas principais responsabilidades incluem:
- Consolidar especificações e requisitos do sistema
- Criar a arquitetura de API que se ajusta às metas definidas
- Desenvolver, proteger e publicar as APIs
- Testar e garantir que as APIs atendam aos requisitos de funcionamento e desempenho
- Documentar as APIs
- Operações de manutenção de API, que incluem o gerenciamento de versões e atualizações
Os produtores de API se esforçam para garantir que estejam seguindo as melhores práticas, as políticas de segurança e conformidade e os padrões de API organizacional para consistência. Eles também precisam garantir que não estejam duplicando o esforço de outras equipes anteriores ou de outras equipes dentro da organização.
Consumidores de API – eles podem ser usuários internos ou externos das APIs que:
- Consumir APIs privadas em seus fluxos de trabalho e serviços de negócios internos (consumidores internos)
- Usar pontos de extremidade de API restritos para se integrar a parcerias comerciais estratégicas (consumidores parceiros)
- Consumir APIs disponíveis publicamente para criar sistemas externos que usam serviços fornecidos pela organização (consumidores de terceiros)
Os consumidores de API precisam garantir a descoberta rápida das APIs mais adequadas para suas cargas de trabalho, de modo a evitar o desperdício de recursos de desenvolvimento valiosos e de esforços em duplicatas. Para isso, é importante que eles recebam documentação de qualidade e fácil de usar para validar as APIs que resolvem suas respectivas necessidades, e que elas possam se integrar perfeitamente aos seus aplicativos.
Equipe da Plataforma de API – Os engenheiros da Plataforma de API se preocupam em criar e manter arquiteturas de API escalonáveis, seguras e de alto desempenho para sua organização. Algumas de suas tarefas podem incluir:
- Design e desenvolvimento de arquitetura de API
- Estabelecer e impor as melhores práticas de API e padrões de design em toda a organização
- Impor monitoramento, análise e relatórios para gerar insights acionáveis
- Implementar e gerenciar a segurança da API por meio de protocolos de autenticação, autorização e criptografia
- Facilitar a colaboração e os comentários entre gerentes de produto, produtores de API e consumidores para se alinharem às estratégias de API
- Auxiliar na integração da API e solucionar problemas tanto interna quanto externamente
Os engenheiros da Plataforma de API da Contoso trabalham juntos para implementar uma estratégia fácil de adotar que impedirá a organização de experimentar a expansão da API.
Como funciona o Centro de API
Os engenheiros da Plataforma de API em uma organização precisam de uma maneira rápida e fácil de configurar um repositório centralizado de todas as suas APIs (internas e externas), juntamente com quaisquer outros metadados, como versões de API, definições e muito mais. Com o Centro de API, você pode criar um catálogo de APIs hospedadas e gerenciadas em diferentes soluções de gerenciamento de API e gerenciá-las em seus diferentes ciclos de vida de design, desenvolvimento, teste e produção.
Funcionalidades do Centro de API do Azure
Inventário de API
O Centro de API está fundamentado na criação de um inventário completo e atualizado de todas as APIs criadas e usadas em toda a organização. Esse inventário é fundamental para habilitar a governança, a descoberta e o consumo da API em escala.
Com o Centro de API, você pode adicionar APIs ao inventário, independentemente de:
- Tecnologia e linguagem de API: API Web do ASP.NET Core, Express, FastAPI, API sem servidor, etc.
- Tipo de API: REST, GraphQL, SOAP, gRPC, WebSocket, WebHook, etc.
- Ambiente de runtime: Cluster do Kubernetes, aplicativo Web, Gerenciamento de API, Gerenciamento de API do Apigee, Azure Functions, etc.
Governança de API
Agora, com um inventário de API completo, precisamos examinar como podemos garantir que essas APIs sejam consistentes, padronizadas, utilizáveis e seguras. A governança de API é definida como a prática de definir e aplicar padrões, políticas e processos em escala em todas as APIs organizacionais.
Esta funcionalidade no Centro de API simplifica o acompanhamento de APIs usando metadados como versões, proprietários, ciclo de vida e acompanhamento de processos como revisões de conformidade, detecção de alterações interruptivas, etc.
O Centro de API também oferece ferramentas relacionadas à governança de design de API com suporte para lint, implementadas usando o linter JSON/YAML Spectral, que garante que as APIs registradas estejam em conformidade com as regras de estilo da organização e fornece uma funcionalidade de análise para suas APIs. Habilitar isto para a sua organização ajuda na detecção antecipada de erros e inconsistência gerando um relatório de conformidade que pode ser exibido no Centro de API.
Os esforços da Plataforma de API são mais bem-sucedidos quando eles têm a entrada do desenvolvedor. A extensão do Centro de API para Visual Studio Code fornece recursos de governança de API shift-left para detecção de alterações e governança de design de API para garantir que as APIs sejam criadas da maneira correta na primeira vez.
Descoberta e consumo de API
O Centro de API simplifica todo o ciclo de vida de desenvolvimento de API, melhorando a experiência do desenvolvedor integrando-se a ferramentas de desenvolvedor populares, como o Visual Studio Code. A extensão do Centro de API fornece uma experiência para os consumidores de API descobrirem, experimentarem e consumirem APIs diretamente dentro do Visual Studio Code no contexto de como eles já funcionam. Outra funcionalidade do Centro de API é um portal tradicional do Centro de API baseado na Web, projetado para permitir que os consumidores de API naveguem facilmente pela documentação, descubram, acessem e consumam APIs do catálogo de API.
Na próxima unidade, você verá como criar e gerenciar seu inventário de API com o Centro de API por meio do portal do Azure, localmente usando a CLI do Azure ou no VS Code usando a extensão do Centro de API.