Governar APIs com a extensão do Centro de APIs do Azure para Visual Studio Code
Para maximizar o sucesso de seus esforços de governança de API, é fundamental mudar a governança para a esquerda no início do ciclo de desenvolvimento da API. Essa abordagem permite que os desenvolvedores de API criem APIs corretamente desde o início, poupando-as do esforço de desenvolvimento desperdiçado e mitigando APIs não compatíveis mais tarde no processo de desenvolvimento.
A extensão do Centro de API do Azure para Visual Studio Code inclui os seguintes recursos de governança para desenvolvedores de API:
- Avaliando designs de API em relação a guias de estilo de API à medida que a API é desenvolvida no Visual Studio Code.
- Deteção precoce de alterações significativas para que as APIs permaneçam confiáveis e funcionem conforme o esperado, preservando a confiança dos usuários finais e das partes interessadas.
Os desenvolvedores de API também podem aproveitar os recursos da extensão para registrar APIs no centro de APIs e descobrir e consumir APIs.
Pré-requisitos
Um ou mais centros de API na sua subscrição do Azure.
- Atualmente, você precisa receber a função de Colaborador de Serviço do Centro de API do Azure ou permissões superiores em um centro de API para gerenciar APIs com a extensão.
- Extensão espectral para Visual Studio Code - para executar verificações de conformidade de design de API shift-left no Visual Studio Code
- CLI ótica - para detetar alterações de quebra entre documentos de especificação de API
Configurar
Instale a extensão do Centro de API do Azure para Visual Studio Code a partir do Visual Studio Code Marketplace. Instale outras extensões conforme necessário.
Nota
Quando observado, determinados recursos estão disponíveis somente na versão de pré-lançamento da extensão do Centro de API do Azure. Ao instalar a extensão do Visual Studio Code Marketplace, você pode optar por instalar a versão de lançamento ou uma versão de pré-lançamento. Alterne entre as duas versões a qualquer momento usando o menu de contexto do botão Gerenciar da extensão na visualização Extensões.
No Visual Studio Code, na barra de atividades à esquerda, selecione Central de APIs.
Se não tiver sessão iniciada na sua conta do Azure, selecione Iniciar sessão no Azure..., e siga as instruções para iniciar sessão. Selecione uma assinatura do Azure com o centro de API (ou centros de API) do qual você deseja exibir APIs. Também pode filtrar subscrições específicas se tiver muitas para visualizar.
Conformidade do projeto da API
Para garantir a conformidade do projeto com os padrões organizacionais à medida que você cria APIs, a extensão do Centro de API do Azure para Visual Studio Code fornece suporte integrado para forro de especificação de API com o Spectral.
- Use o atalho de teclado Ctrl+Shift+P para abrir a Paleta de Comandos. Digite Central de API do Azure: defina o Guia de Estilo da API ativa e pressione Enter.
- Selecione uma das regras padrão fornecidas ou, se sua organização tiver um guia de estilo já disponível, use Selecionar Arquivo Local ou URL Remoto de Entrada para especificar o conjunto de regras ativo no Visual Studio Code. Pressione Enter.
Depois que um guia de estilo de API ativo é definido, abrir qualquer arquivo de especificação baseado em OpenAPI ou AsyncAPI dispara uma operação de revestimento local no Visual Studio Code. Os resultados são exibidos embutidos no editor e na janela Problemas (Exibir>problemas ou Ctrl+Shift+M).
Deteção de alterações de rutura
Ao introduzir novas versões da sua API, é importante garantir que as alterações introduzidas não quebrem os consumidores de API em versões anteriores da sua API. A extensão do Centro de API do Azure para Visual Studio Code facilita isso com a deteção de alterações de quebra para documentos de especificação OpenAPI com tecnologia Optic.
- Use o atalho de teclado Ctrl+Shift+P para abrir a Paleta de Comandos. Digite Azure API Center: Detect Breaking Change e pressione Enter.
- Selecione o primeiro documento de especificação da API para comparar. As opções válidas incluem especificações de API encontradas em seu centro de API, um arquivo local ou o editor ativo no Visual Studio Code.
- Selecione o segundo documento de especificação da API para comparar. As opções válidas incluem especificações de API encontradas em seu centro de API, um arquivo local ou o editor ativo no Visual Studio Code.
O Visual Studio Code abre uma exibição de comparação entre as duas especificações de API. Quaisquer alterações significativas são exibidas em linha no editor e na janela Problemas (Exibir>problemas ou Ctrl+Shift+M).
