O que é o Centro de APIs 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 suas APIs organizacionais, permitindo rastreamento, 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 do desenvolvimento ou local de implantação para o tempo de execução 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 |
|---|---|
| Pouca capacidade de descoberta e reutilização de 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. |
| APIs sombra e não governadas | 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. |
| Potenciais ameaças à segurança | Facilidade de governança de API. Com as APIs consolidadas em um único local, governar 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 automatizadas de conformidade do projeto de API. A Central de APIs permite que os administradores imponham padrões de design em todas as APIs e implementa um fluxo de trabalho de revestimento que verifica as APIs em relação a um guia de estilo definido e gera um relatório de conformidade de API acessível em sua Central de APIs. |
Funções do ecossistema da API & responsabilidades
O ecossistema de API de uma organização geralmente consiste em diferentes funções com diversas responsabilidades que são essenciais para sua operação bem-sucedida. Vamos dar uma olhada mais de perto em alguns dos papéis.
Produtores de API - Estes podem ser desenvolvedores individuais ou equipes cujas principais responsabilidades incluem:
- Consolidação das especificações e requisitos do sistema
- Projetando a arquitetura de API que se adapta aos objetivos definidos
- Desenvolvendo, protegendo e publicando as APIs
- Testando e garantindo que as APIs atendam aos requisitos funcionais e de desempenho
- Documentando 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 estão seguindo as melhores práticas, políticas de segurança e conformidade e padrões organizacionais de API para consistência. Eles também precisam garantir que não estão duplicando o esforço de outras equipes anteriores dentro da organização.
Consumidores de API - Estes podem ser usuários internos ou externos das APIs que:
- Consumir APIs privadas em seus fluxos de trabalho e serviços internos de negócios (consumidores internos)
- Use endpoints de API restritos para integração em parcerias estratégicas de negócios (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 que descubram rapidamente as APIs mais adequadas para suas cargas de trabalho, a fim de evitar o desperdício de valiosos recursos de desenvolvimento e esforços em duplicações. Para conseguir isso, é importante que eles recebam documentação de qualidade e fácil de usar para validar as APIs que resolvem suas respetivas necessidades e que possam se integrar perfeitamente em seus aplicativos.
Equipe da plataforma API - Os engenheiros da plataforma API se preocupam em criar e manter arquiteturas de API escaláveis, seguras e de alto desempenho para sua organização. Algumas das suas tarefas podem incluir:
- Projeto e desenvolvimento de arquitetura API
- Estabeleça e aplique as práticas recomendadas de API e os padrões de design em toda a organização
- Aplique 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
- Facilite a colaboração e o feedback entre gerentes de produto, produtores de API e consumidores para alinhar as estratégias de API
- Auxiliar na integração de API e na solução de problemas internos e externos
Os engenheiros da Plataforma de API da Contoso trabalham juntos para implementar uma estratégia fácil de adotar que evitará que a organização sofra expansão da API.
Como funciona o Centro de API
Os engenheiros da plataforma 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 APIs, 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.
Recursos do Centro de API do Azure
Inventário da API
Na base do Centro de API está a construçã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 permitir a governança, a descoberta e o consumo de API em escala.
Com o Centro de APIs, você pode adicionar APIs ao seu inventário, independentemente de:
- Tecnologia API & linguagem: ASP.NET Core Web API, Express, FastAPI, serverless API, etc.
- Tipo de API: REST, GraphQL, SOAP, gRPC, WebSocket, WebHook, etc.
- Ambiente de tempo de execução: cluster Kubernetes, Web App, Gerenciamento de API, Gerenciamento de API do Apigee, Azure Functions, etc.
Governança da API
Agora, com um inventário completo de APIs, precisamos analisar 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.
Esse recurso no Centro de API simplifica o rastreamento de APIs usando metadados como versões, proprietários, ciclo de vida e rastreamento de processos, como revisões de conformidade, deteção de alterações de quebra, etc.
O Centro de API também oferece ferramentas em torno da governança de design de API que suporta linting, implementado usando o lint Spectral JSON/YAML, que garante que as APIs registradas estejam em conformidade com as regras de estilo da organização e forneça uma funcionalidade de análise para suas APIs. Habilitar isso para sua organização ajuda na deteção precoce de erros e inconsistências, gerando um relatório de conformidade que pode ser visualizado em sua Central de APIs.
Os esforços da Plataforma API são mais bem-sucedidos quando têm a adesão do desenvolvedor. A extensão do Centro de API para Visual Studio Code fornece recursos de governança de API shift-left para quebrar a deteção de alterações e a governança de design de API para garantir que as APIs sejam criadas da maneira certa na primeira vez.
Descoberta de API e consumo
O Centro de API simplifica todo o ciclo de vida de desenvolvimento da API, melhorando a experiência do desenvolvedor por meio da integração com 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 elas já funcionam. Outro recurso do Centro de API é um portal tradicional do Centro de API baseado na Web, projetado para permitir que os consumidores de API naveguem facilmente na documentação, descubram, acessem e consumam APIs do seu catálogo de APIs.
Na próxima unidade, você verá como pode 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.