Centro de API do Azure - conceitos-chave
Este artigo explica os principais conceitos do Centro de API do Azure. A Central de APIs do Azure permite o rastreamento de APIs em um local centralizado para descoberta, reutilização e governança.
Modelo de dados
O diagrama a seguir mostra as principais entidades na Central de API do Azure e como elas se relacionam entre si. Consulte as seções a seguir para obter mais informações sobre essas entidades e conceitos relacionados.
API
Uma entidade lógica de nível superior no Centro de API do Azure, uma API representa qualquer API do mundo real que você deseja rastrear. Um centro de API pode incluir APIs de qualquer tipo, incluindo REST, GraphQL, gRPC, SOAP, WebSocket e Webhook.
Uma API no inventário pode ser gerenciada por qualquer solução de gerenciamento de API, como Gerenciamento de API do Azure, Gerenciamento de API do Apigee, Kong Konnect, Gerenciamento de API MuleSoft ou outra plataforma. Uma API representada na Central de APIs do Azure também pode ser não gerenciada.
O inventário de API no Centro de API do Azure foi projetado para ser criado e gerenciado por gerentes de programa de API ou administradores de TI. A Central de APIs do Azure também inclui recursos para que os desenvolvedores de API registrem definições de API diretamente de seus ambientes de desenvolvimento, como Visual Studio Code ou pipelines de CI/CD.
Versão da API
O controle de versão da API é a prática de gerenciar alterações em uma API e garantir que essas alterações sejam feitas sem interromper os clientes. Uma API pode ter várias versões em todos os estágios do ciclo de vida, cada uma alinhada com alterações específicas da API. Algumas versões podem introduzir alterações importantes ou de rutura, enquanto outras adicionam pequenas melhorias. Uma versão da API pode estar em qualquer estágio do ciclo de vida – desde o projeto até a visualização, produção ou preterida.
Definição de API
Idealmente, cada versão da API deve ser definida por pelo menos uma definição, como uma definição de OpenAPI para uma API REST. A Central de API do Azure permite qualquer arquivo de definição de API formatado como texto (YAML, JSON, Markdown e assim por diante). Você pode carregar definições OpenAPI, gRPC, GraphQL, AsyncAPI, WSDL e WADL, entre outras.
Para ajudar com a governança da API, a Central de APIs do Azure fornece recursos de revestimento para analisar as definições de API quanto à qualidade e conformidade com os padrões organizacionais.
Environment
Um ambiente representa um local onde um tempo de execução de API pode ser implantado, por exemplo, um serviço de Gerenciamento de API do Azure, um serviço de Gerenciamento de API do Apigee ou um serviço de computação, como um cluster Kubernetes, um Aplicativo Web ou uma Função do Azure. Cada ambiente é alinhado com um estágio do ciclo de vida, como desenvolvimento, teste, preparação ou produção. Um ambiente também pode incluir informações sobre o portal do desenvolvedor ou interfaces de gerenciamento.
Nota
Use a Central de API do Azure para rastrear qualquer um dos seus ambientes de tempo de execução de API, estejam eles hospedados ou não na infraestrutura do Azure. Esses ambientes não são iguais aos Ambientes de Implantação do Azure.
Implementação
Uma implantação é um local (um endereço) onde os usuários podem acessar uma API. Uma API pode ter várias implantações, como diferentes ambientes de preparo ou regiões. Por exemplo, uma API pode ter uma implantação em um ambiente de preparo interno e uma segunda em um ambiente de produção. Cada implantação está associada a uma definição de API específica.
Metadados
No Centro de API do Azure, organize suas APIs, implantações e outras entidades definindo valores de metadados, que podem ser usados para pesquisa e filtragem e para impor padrões de governança. Um centro de API fornece várias propriedades comuns de metadados internos, como "tipo de API" e "estágio do ciclo de vida". O proprietário do centro de API pode aumentar os metadados internos definindo metadados personalizados em um esquema de metadados para organizar suas APIs, implantações e ambientes. Por exemplo, crie uma propriedade de aprovador de API para identificar o indivíduo responsável pela aprovação de uma API para uso.
O Centro de API do Azure dá suporte a metadados personalizados do tipo matriz, booleano, número, objeto, opções predefinidas e cadeia de caracteres.
O esquema de metadados do Centro de API do Azure é compatível com as especificações de esquema JSON e YAML, para permitir a validação de esquema em ferramentas de desenvolvedor e pipelines automatizados.