O que é o Azure Centro de API (versão prévia)?

O Centro de API permite o acompanhamento de todas as suas APIs em um local centralizado para descoberta, reutilização e governança. Use o Centro de API para desenvolver e manter um inventário estruturado e organizado das APIs da sua organização, seja qual for o tipo, a fase do ciclo de vida ou o local da implantação, acompanhado de informações relacionadas, como detalhes da versão, arquivos de definição de API e metadados comuns.

Com o Centro de API, as partes interessadas em toda a sua organização, incluindo gerentes de programas de API, administradores de TI, desenvolvedores de aplicativos e desenvolvedores de API, podem descobrir, reutilizar e governar APIs.

Importante

  • O Centro de API está em versão preliminar. Essa versão prévia é fornecida sem um contrato de nível de serviço, e você pode esperar, ocasionalmente, alterações significativas durante a versão prévia. As alterações no modelo de dados de visualização do Centro de API podem levar à perda de dados. Para obter mais informações, consulte Termos de Uso Complementares de Versões Prévias do Microsoft Azure.
  • Durante a versão preliminar, solicite recursos, relate bugs ou forneça outros comentários nesse repositório do GitHub.

Observação

O Centro de API é uma solução para as organizações catalogarem e gerenciarem o próprio inventário de API. O Azure também oferece o serviço Gerenciamento de API, uma solução para gerenciar, proteger e publicar os back-ends de API da sua organização através de um gateway de API. Saiba mais sobre a diferença.

Benefícios

  • Criar e manter um inventário organizacional – As organizações podem criar um inventário completo de APIs disponíveis em sua organização. Promova a comunicação e permita que os gerentes e desenvolvedores de programas de API colaborem para aumentar a reutilização, a qualidade, a segurança, a conformidade e a produtividade do desenvolvedor da API.

  • Governe as APIs da sua organização – com uma visibilidade mais completa das APIs que estão sendo produzidas e usadas em uma organização, os gerentes de programas de API e os administradores de TI podem controlar esse inventário para garantir que ele atenda aos padrões organizacionais definindo metadados personalizados e analisando definições de API para impor a conformidade às diretrizes de estilo de API.

  • Descoberta de API Fácil – as organizações desejam promover a reutilização da API para maximizar a produtividade do desenvolvedor e garantir que os desenvolvedores estejam usando as APIs corretas. O Centro de API ajuda gerentes de programas e desenvolvedores a descobrir o inventário de API e filtrar usando propriedades de metadados internas e personalizadas. ​

  • Acelerar o consumo de API – maximizar a produtividade do desenvolvedor ao consumir APIs e garantir que elas sejam consumidas de maneira segura e consistente com os padrões organizacionais.

Principais recursos

Na pré-visualização, crie e use uma Central de API no portal do Azure para o seguinte:

  • Gerenciamento do inventário de APIs: registra todas as APIs da sua organização para inclusão em um inventário centralizado.

  • Representação da API no mundo real – Adiciona informações reais sobre cada API, incluindo versões e definições, como as definições da OpenAPI. Listar implantações de API e associá-las a ambientes de runtime, por exemplo, representando o Gerenciamento de API do Azure ou outras soluções de gerenciamento de API.

  • Governança de API – organiza e filtra APIs e recursos relacionados usando as propriedades de metadados internas e personalizadas, para ajudar na governança da API e na capacidade de descoberta pelos consumidores da API. Configure lint e análise para impor a qualidade da definição de API.

  • Descoberta e reutilização de API – permitir que desenvolvedores e gerentes de programas de API descubram APIs por meio do portal do Azure, um portal do Centro de APIs e ferramentas de desenvolvedor, incluindo uma extensão do Visual Studio Code integrada ao GitHub Copilot.

Para obter mais informações sobre as entidades que você pode gerenciar e os recursos no Centro de APIs, consulte os Principais conceitos.

Regiões disponíveis

Na versão prévia, o Centro de API está disponível nas seguintes regiões do Azure:

  • Leste da Austrália
  • Índia Central
  • Leste dos EUA
  • Sul do Reino Unido
  • Europa Ocidental

Centro de API e ecossistema de API

O Centro de API pode fazer um papel fundamental no ecossistema de API de uma organização. Considere a organização fictícia Contoso, que adotou uma estratégia de priorização de API, enfatizando a importância das APIs no desenvolvimento e integração de software da empresa.

Os desenvolvedores de API, os desenvolvedores de aplicativos, os gerentes de programas de API e os gerentes de API da Contoso colaboram por meio do Centro de API do Azure para desenvolver e usar o inventário de API da organização. Veja o diagrama e a explicação a seguir.

Diagram showing API Center in an example API ecosystem.

O ecossistema inclui o seguinte:

  • Desenvolvimento de API – os desenvolvedores da Contoso criam regularmente APIs Web ASP.NET. Eles também criam Azure Functions com gatilhos HTTP.

  • Ambientes de implantação de API – a Contoso implanta uma parte das APIs deles no Serviço de Aplicativo do Azure. Outro subconjunto das APIs deles é implantado em um aplicativo de funções do Azure.

  • Gerenciamento de API – a Contoso usa o Gerenciamento de API do Azure para gerenciar, publicar e proteger as APIs deles. Eles usam instâncias separadas para Desenvolvimento, Teste e Produção, cada uma com um nome distinto: APIM-DEV, APIM-TEST e APIM-PROD.

  • Centro de API – a Contoso adotou o Centro de API do Azure como o hub centralizado deles para descoberta, governança e consumo de APIs. O Centro de API serve como um hub de API estruturado e organizado que fornece informações abrangentes sobre todas as APIs organizacionais, mantendo informações relacionadas, incluindo versões e implantações associadas.

Perguntas frequentes

Qual é a diferença entre o Gerenciamento de API do Azure e o Centro de API do Azure?

R: o Gerenciamento de API do Azure é um serviço do Azure totalmente gerenciado que ajuda as organizações a expor com segurança as APIs deles a clientes externos e internos. Ele fornece um conjunto de ferramentas e serviços para criar, publicar e gerenciar APIs, além de impor segurança, dimensionamento e monitoramento do uso da API.

Por outro lado, o Centro de API do Azure ajuda as organizações a criar um catálogo de APIs que estão disponíveis na organização. O Centro de API do Azure fornece informações básicas sobre as APIs, como nome, descrição e versão, mas informações adicionais podem ser adicionadas a essas APIs usando metadados personalizados. O Centro de API do Azure ajuda diferentes stakeholders, como gerentes de API ou desenvolvedores de API, a descobrir e reutilizar APIs existentes na organização.

Embora ambos os serviços forneçam ferramentas para controlar APIs, eles atendem a finalidades diferentes. O Gerenciamento de API do Azure é uma plataforma para criar, publicar e gerenciar APIs, enquanto o Centro de API fornece um local centralizado para descobrir e reutilizar APIs existentes em uma organização.

P: Como usar o Centro de API com minha solução de Gerenciamento de API?

R: O Centro de API é um serviço autônomo do Azure que complementa o Gerenciamento de API do Azure e os serviços de gerenciamento de API de outros provedores. O Centro de API fornece um inventário unificado de APIs para todas as APIs da organização, incluindo as APIs que não são executadas em gateways de API (como aquelas que ainda estão em projeto) e aquelas que são gerenciadas com diferentes soluções de gerenciamento de API.

Para APIs gerenciadas usando uma solução de gerenciamento de API, o Centro de API pode armazenar metadados, como o ambiente de runtime e os detalhes da implantação.

P: Meus dados estão criptografados no Centro de API?

R: Sim, todos os dados no Centro de API são criptografados quando inativos.

Próximas etapas