Tutorial: utilize as revisões para efetuar alterações de API sem interrupções de forma segura
APLICA-SE A: Todas as camadas de gerenciamento de API
Quando sua API estiver pronta para uso e for usada por desenvolvedores, você eventualmente precisará fazer alterações nessa API e, ao mesmo tempo, não interromper os chamadores de sua API. É também útil dar a conhecer aos programadores as alterações que efetuou.
No Gerenciamento de API do Azure, use revisões para fazer alterações de API ininterruptas para que você possa modelar e testar as alterações com segurança. Quando estiver pronto, você poderá fazer uma revisão atual e substituir sua API atual.
Para obter plano de fundo, consulte Versões e revisões de API e Controle de versão de API com o Gerenciamento de API do Azure.
Neste tutorial, irá aprender a:
- Adicionar uma nova revisão
- Efetuar alterações sem interrupções à revisão
- Tornar a revisão atual e adicionar uma entrada de registo de alterações
- Navegar até ao portal do programador para ver as alterações e o registo de alterações
Pré-requisitos
- Conhecer a terminologia da Gestão de API do Azure.
- Conclua o guia de início rápido seguinte: Criar uma instância da Gestão de API do Azure.
- Conclua também o tutorial seguinte: Importar e publicar a sua primeira API.
Adicionar uma nova revisão
Entre no portal do Azure e vá para sua instância de Gerenciamento de API.
Selecione APIs.
Selecione API de conferência de demonstração na lista de APIs (ou outra API à qual você deseja adicionar revisões).
Selecione a guia Revisões .
Selecione + Adicionar revisão.
Gorjeta
Você também pode selecionar Adicionar revisão no menu de contexto (...) da API.
Forneça uma descrição para sua nova revisão, para ajudar a lembrar para que ela será usada.
Selecione Criar.
A sua nova revisão está agora criada.
Nota
A API original permanece em Revisão 1. Trata-se da revisão que os utilizadores continuam a chamar, até optar por tornar uma revisão diferente atual.
Efetuar alterações sem interrupções à revisão
Selecione Demo Conference API na lista de APIs.
Selecione o separador Estrutura junto à parte superior do ecrã.
Tenha em atenção que o seletor de revisões (diretamente acima do separador de estrutura) mostra a Revisão 2 como atualmente selecionada.
Gorjeta
Utilize o seletor de revisões para alternar entre revisões em que quer trabalhar.
Selecione + Adicionar Operação.
Defina sua nova operação como POST e o Nome, Nome para Exibição e URL da operação como teste.
Guarde a nova operação.
Agora você fez uma alteração na Revisão 2. Use o seletor de revisão na parte superior da página para voltar para a Revisão 1.
Observe que sua nova operação não aparece na Revisão 1.
Tornar a revisão atual e adicionar uma entrada de registo de alterações
Selecione o separador Revisões no menu junto à parte superior da página.
Abra o menu de contexto (...) para Revisão 2.
Selecione Tornar atual.
Marque a caixa de seleção Publicar no log de alterações públicas para esta API , se quiser postar anotações sobre essa alteração. Forneça uma descrição para sua alteração que os desenvolvedores possam ver, por exemplo: Revisões de teste. Adicionada nova operação de "teste".
Revisão 2 é agora atual.
Navegar até ao portal do programador para ver as alterações e o registo de alterações
Se você já tentou o portal do desenvolvedor, você pode revisar as alterações da API e o log de alterações lá.
- No portal do Azure, selecione APIs.
- Selecione Portal do desenvolvedor no menu superior.
- No portal do desenvolvedor, selecione APIs e, em seguida, selecione API de conferência de demonstração.
- Tenha em atenção que a nova operação test está agora disponível.
- Selecione Changelog perto do nome da API.
- Observe que sua entrada de log de alterações aparece na lista.
Próximos passos
Neste tutorial, ficou a saber como:
- Adicionar uma nova revisão
- Efetuar alterações sem interrupções à revisão
- Tornar a revisão atual e adicionar uma entrada de registo de alterações
- Navegar até ao portal do programador para ver as alterações e o registo de alterações
Avance para o tutorial seguinte: