Trabalhando com múltiplas versões

O API Designer permite que você trabalhe com várias versões da mesma definição de API para ajudar a gerenciar o ciclo de vida da sua API. Você pode:

Manter uma versão de API existente em produção enquanto introduz mudanças significativas ou quebras em uma nova versão.
Obtenha visibilidade e controle sobre as versões publicadas.
Obtenha flexibilidade ao projetar alterações em uma API.

Quando você cria uma nova versão de uma API, todo o conteúdo é copiado para a nova versão e cada versão pode ser modificada independentemente sem afetar as outras.

A página inicial do API Designer exibe todas as APIs de sua propriedade e todas as versões de API compartilhadas com você.

Criando uma nova versão de API

Crie uma nova versão de uma definição de API existente.

Você é proprietário da API ou editor de pelo menos uma versão da API.

Na página inicial, vá para a API para a qual você deseja criar uma nova versão.
Você pode filtrar a lista por nome ou proprietário, se necessário.
Clique no botão ao lado da versão que você deseja copiar e clique em Criar uma nova versão a partir de <versão>.
Insira a nova versão.
Clique em Criar.

Uma nova versão da sua API é criada com o mesmo conteúdo da versão de origem. A simulação e a documentação estão desabilitadas por padrão.

Excluindo uma versão da API

Você é o proprietário da API.

Na página inicial, clique no botão ao lado da versão que deseja excluir e clique em Excluir.
Clique em Excluir para confirmar.

A versão selecionada é excluída. Se você quiser excluir uma API inteira, precisará excluir cada versão.

Importando conteúdo da versão

Importe o conteúdo de um contrato existente para uma versão da API, substituindo ou mesclando seu conteúdo atual.

Você é o proprietário da API ou editor da versão da API.

Use esse recurso para atualizar uma versão de um arquivo de contrato externo sem criar uma nova versão. O identificador da versão é preservado durante toda a importação.

Isso é diferente de importar uma definição, que cria uma nova API no API Designer.

Abra Importar conteúdo da versão para a versão que deseja atualizar.
Você pode acessar esta ação nos seguintes locais:
- Na página inicial, clique no botão de menu ao lado da versão e clique em Importar conteúdo da versão.
- Na página inicial, selecione a versão para abrir o painel de detalhes e clique em Importar conteúdo da versão.
- No editor de versões, clique em Editar > Importar conteúdo da versão.
Selecione um formato e uma origem para o contrato a ser importado.
Você pode importar de um arquivo local, de uma URL ou de texto que você cola diretamente na caixa de diálogo.
Em Comportamento, selecione como aplicar o conteúdo importado.
- Substituir: substitui todo o conteúdo atual pelo contrato importado. O nome da API, o identificador de versão e a versão da especificação são preservados.
- Mesclar: combina o conteúdo importado com o conteúdo da versão existente. O nome da API e o identificador da versão são preservados. Se um elemento importado tiver o mesmo nome que um elemento existente, o elemento importado será renomeado com o sufixo _merge (por exemplo, User_merge). URLs base e tipos de mídia duplicados são ignorados.
Clique em Importar.

O editor de versões é aberto com o conteúdo atualizado aplicado.

Esta página ajudou?

Se você encontrar algum problema com esta página ou seu conteúdo – um erro de digitação, uma etapa ausente ou um erro técnico – avise-nos!

Deixe seu feedback aqui